MyApp

<back to all web services

QueryProfile

Game
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class QueryProfile : QueryDb<Profile>()
{
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    var skip:Int? = null

    @DataMember(Order=2)
    var take:Int? = null

    @DataMember(Order=3)
    var orderBy:String? = null

    @DataMember(Order=4)
    var orderByDesc:String? = null

    @DataMember(Order=5)
    var include:String? = null

    @DataMember(Order=6)
    var fields:String? = null

    @DataMember(Order=7)
    var meta:HashMap<String,String> = HashMap<String,String>()
}

open class Profile : AuditBase()
{
    var id:Int? = null
    var role:PlayerRole? = null
    var region:PlayerRegion? = null
    var username:String? = null
    var highScore:Long? = null
    var gamesPlayed:Long? = null
    var energy:Int? = null
    var profileUrl:String? = null
    var coverUrl:String? = null
    var meta:HashMap<String,String> = HashMap<String,String>()
}

@DataContract
open class AuditBase
{
    @DataMember(Order=1)
    var createdDate:Date? = null

    @DataMember(Order=2)
    @Required()
    var createdBy:String? = null

    @DataMember(Order=3)
    var modifiedDate:Date? = null

    @DataMember(Order=4)
    @Required()
    var modifiedBy:String? = null

    @DataMember(Order=5)
    var deletedDate:Date? = null

    @DataMember(Order=6)
    var deletedBy:String? = null
}

enum class PlayerRole
{
    Leader,
    Player,
    NonPlayer,
}

enum class PlayerRegion(val value:Int)
{
    Africa(1),
    Americas(2),
    Asia(3),
    Australasia(4),
    Europe(5),
}

@DataContract
open class QueryResponse<Todo>
{
    @DataMember(Order=1)
    var offset:Int? = null

    @DataMember(Order=2)
    var total:Int? = null

    @DataMember(Order=3)
    var results:ArrayList<Todo> = ArrayList<Todo>()

    @DataMember(Order=4)
    var meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var responseStatus:ResponseStatus? = null
}

open class Todo
{
    var id:Long? = null
    var text:String? = null
    var isFinished:Boolean? = null
}

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