MyApp

<back to all web services

QueryPlayer

Game
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Player Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FirstNameformstringYes
LastNameformstringYes
EmailformstringYes
PhoneNumbersformList<Phone>Yes
GameItemsformList<PlayerGameItem>Yes
ProfileformProfileYes
ProfileIdformintNo
SavedLevelIdformGuidNo
RowVersionformulongNo
AuditBase Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo
Phone Parameters:
NameParameterData TypeRequiredDescription
KindformPhoneKindNo
NumberformstringYes
ExtformstringYes
PhoneKind Enum:
Home
Mobile
Work
PlayerGameItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PlayerIdformintNo
GameItemNameformstringYes
Profile Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
RoleformPlayerRoleNo
RegionformPlayerRegionNo
UsernameformstringNo
HighScoreformlongNo
GamesPlayedformlongNo
EnergyformintNo
ProfileUrlformstringNo
CoverUrlformstringNo
MetaformDictionary<string, string>No
PlayerRole Enum:
Leader
Player
NonPlayer
PlayerRegion Enum:
NameValue
Africa1
Americas2
Asia3
Australasia4
Europe5
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Todo>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Todo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TextformstringYes
IsFinishedformboolNo

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/QueryPlayer 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,
			firstName: String,
			lastName: String,
			email: String,
			phoneNumbers: 
			[
				{
					kind: Home,
					number: String,
					ext: String
				}
			],
			gameItems: 
			[
				{
					id: 0,
					playerId: 0,
					gameItemName: String
				}
			],
			profile: 
			{
				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
			},
			profileId: 0,
			savedLevelId: 00000000000000000000000000000000,
			rowVersion: 0,
			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
		}
	}
}