MyApp

<back to all web services

QueryUsers

Requires Authentication
Required role:Admin
import Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAdmin")
public class QueryUsers : QueryDb<User>
{
    public var id:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
    }
}

public class User : Codable
{
    public var id:String
    public var userName:String
    public var firstName:String
    public var lastName:String
    public var displayName:String
    public var profileUrl:String

    required public init(){}
}

/**
* Booking Details
*/
public class Booking : AuditBase
{
    public var id:Int
    public var name:String
    public var roomType:RoomType
    public var roomNumber:Int
    public var bookingStartDate:Date
    public var bookingEndDate:Date?
    public var cost:Double
    // @References(typeof(Coupon))
    public var couponId:String

    public var discount:Coupon
    public var notes:String
    public var cancelled:Bool?
    public var employee:User

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case name
        case roomType
        case roomNumber
        case bookingStartDate
        case bookingEndDate
        case cost
        case couponId
        case discount
        case notes
        case cancelled
        case employee
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        roomType = try container.decodeIfPresent(RoomType.self, forKey: .roomType)
        roomNumber = try container.decodeIfPresent(Int.self, forKey: .roomNumber)
        bookingStartDate = try container.decodeIfPresent(Date.self, forKey: .bookingStartDate)
        bookingEndDate = try container.decodeIfPresent(Date.self, forKey: .bookingEndDate)
        cost = try container.decodeIfPresent(Double.self, forKey: .cost)
        couponId = try container.decodeIfPresent(String.self, forKey: .couponId)
        discount = try container.decodeIfPresent(Coupon.self, forKey: .discount)
        notes = try container.decodeIfPresent(String.self, forKey: .notes)
        cancelled = try container.decodeIfPresent(Bool.self, forKey: .cancelled)
        employee = try container.decodeIfPresent(User.self, forKey: .employee)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if name != nil { try container.encode(name, forKey: .name) }
        if roomType != nil { try container.encode(roomType, forKey: .roomType) }
        if roomNumber != nil { try container.encode(roomNumber, forKey: .roomNumber) }
        if bookingStartDate != nil { try container.encode(bookingStartDate, forKey: .bookingStartDate) }
        if bookingEndDate != nil { try container.encode(bookingEndDate, forKey: .bookingEndDate) }
        if cost != nil { try container.encode(cost, forKey: .cost) }
        if couponId != nil { try container.encode(couponId, forKey: .couponId) }
        if discount != nil { try container.encode(discount, forKey: .discount) }
        if notes != nil { try container.encode(notes, forKey: .notes) }
        if cancelled != nil { try container.encode(cancelled, forKey: .cancelled) }
        if employee != nil { try container.encode(employee, forKey: .employee) }
    }
}

public enum RoomType : String, Codable
{
    case Single
    case Double
    case Queen
    case Twin
    case Suite
}

/**
* Discount Coupons
*/
public class Coupon : Codable
{
    public var id:String
    public var Description:String
    public var discount:Int
    public var expiryDate:Date

    required public init(){}
}


Swift 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
		}
	}
}