MyApp

<back to all web services

QueryProfile

Game
import Foundation
import ServiceStack

public class QueryProfile : QueryDb<Profile>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class Profile : AuditBase
{
    public var id:Int
    public var role:PlayerRole
    public var region:PlayerRegion
    public var username:String
    public var highScore:Int
    public var gamesPlayed:Int
    public var energy:Int
    public var profileUrl:String
    public var coverUrl:String
    public var meta:[String:String] = [:]

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

    private enum CodingKeys : String, CodingKey {
        case id
        case role
        case region
        case username
        case highScore
        case gamesPlayed
        case energy
        case profileUrl
        case coverUrl
        case meta
    }

    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)
        role = try container.decodeIfPresent(PlayerRole.self, forKey: .role)
        region = try container.decodeIfPresent(PlayerRegion.self, forKey: .region)
        username = try container.decodeIfPresent(String.self, forKey: .username)
        highScore = try container.decodeIfPresent(Int.self, forKey: .highScore)
        gamesPlayed = try container.decodeIfPresent(Int.self, forKey: .gamesPlayed)
        energy = try container.decodeIfPresent(Int.self, forKey: .energy)
        profileUrl = try container.decodeIfPresent(String.self, forKey: .profileUrl)
        coverUrl = try container.decodeIfPresent(String.self, forKey: .coverUrl)
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
    }

    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 role != nil { try container.encode(role, forKey: .role) }
        if region != nil { try container.encode(region, forKey: .region) }
        if username != nil { try container.encode(username, forKey: .username) }
        if highScore != nil { try container.encode(highScore, forKey: .highScore) }
        if gamesPlayed != nil { try container.encode(gamesPlayed, forKey: .gamesPlayed) }
        if energy != nil { try container.encode(energy, forKey: .energy) }
        if profileUrl != nil { try container.encode(profileUrl, forKey: .profileUrl) }
        if coverUrl != nil { try container.encode(coverUrl, forKey: .coverUrl) }
        if meta.count > 0 { try container.encode(meta, forKey: .meta) }
    }
}

public enum PlayerRole : String, Codable
{
    case Leader
    case Player
    case NonPlayer
}

public enum PlayerRegion : Int, Codable
{
    case Africa = 1
    case Americas = 2
    case Asia = 3
    case Australasia = 4
    case Europe = 5
}

public class Todo : Codable
{
    public var id:Int
    public var text:String
    public var isFinished:Bool

    required public init(){}
}


Swift QueryProfile 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/QueryProfile HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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: 0,
			role: Leader,
			region: Africa,
			username: String,
			highScore: 0,
			gamesPlayed: 0,
			energy: 0,
			profileUrl: String,
			coverUrl: String,
			meta: 
			{
				String: String
			},
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			deletedBy: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}