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 RoomType = enum {
    Single,
    Double,
    Queen,
    Twin,
    Suite,
};

/// Discount Coupons
pub const Coupon = struct {
    id: ?[]const u8 = null,
    description: ?[]const u8 = null,
    discount: i32 = 0,
    expiryDate: ?[]const u8 = null,
};

/// Booking Details
pub const Booking = struct {
    // @DataMember(Order=1)
    createdDate: ?[]const u8 = null,

    // @DataMember(Order=2)
    // @Required()
    createdBy: ?[]const u8 = null,

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

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

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

    // @DataMember(Order=6)
    deletedBy: ?[]const u8 = null,
    id: i32 = 0,
    name: ?[]const u8 = null,
    roomType: ?RoomType = null,
    roomNumber: i32 = 0,
    bookingStartDate: ?[]const u8 = null,
    bookingEndDate: ?[]const u8 = null,
    cost: f64 = 0,
    // @References(typeof(Coupon))
    couponId: ?[]const u8 = null,

    discount: ?Coupon = null,
    notes: ?[]const u8 = null,
    cancelled: ?bool = null,
    employee: ?User = null,
};

Zig QueryUsers DTOs

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

HTTP + JSV

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

POST /jsv/reply/QueryUsers HTTP/1.1 
Host: blazor-vue.web-templates.io 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}