MyApp

<back to all web services

QueryUsers

Requires Authentication
Required role:Admin
const std = @import("std");

pub const User = struct {
    id: ?[]const u8 = null,
    userName: ?[]const u8 = null,
    firstName: ?[]const u8 = null,
    lastName: ?[]const u8 = null,
    displayName: ?[]const u8 = null,
    profileUrl: ?[]const u8 = null,
};

// @ValidateRequest(Validator="IsAdmin")
pub const QueryUsers = struct {
    // @DataMember(Order=1)
    skip: ?i32 = null,

    // @DataMember(Order=2)
    take: ?i32 = null,

    // @DataMember(Order=3)
    orderBy: ?[]const u8 = null,

    // @DataMember(Order=4)
    orderByDesc: ?[]const u8 = null,

    // @DataMember(Order=5)
    include: ?[]const u8 = null,

    // @DataMember(Order=6)
    fields: ?[]const u8 = null,

    // @DataMember(Order=7)
    meta: ?std.json.Value = null,
    id: ?[]const u8 = null,
};

pub const Todo = struct {
    id: i64 = 0,
    text: ?[]const u8 = null,
    isFinished: bool = false,
};

Zig QueryUsers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/QueryUsers HTTP/1.1 
Host: vue-spa.web-templates.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":"String","userName":"String","firstName":"String","lastName":"String","displayName":"String","profileUrl":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}