Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
FirstName | form | string | Yes | |
LastName | form | string | Yes | |
form | string | Yes | ||
PhoneNumbers | form | List<Phone> | Yes | |
GameItems | form | List<PlayerGameItem> | Yes | |
Profile | form | Profile | Yes | |
ProfileId | form | int | No | |
SavedLevelId | form | Guid | No | |
RowVersion | form | ulong | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreatedDate | form | DateTime | No | |
CreatedBy | form | string | Yes | |
ModifiedDate | form | DateTime | No | |
ModifiedBy | form | string | Yes | |
DeletedDate | form | DateTime? | No | |
DeletedBy | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Kind | form | PhoneKind | No | |
Number | form | string | Yes | |
Ext | form | string | Yes |
Home | |
Mobile | |
Work |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
PlayerId | form | int | No | |
GameItemName | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Role | form | PlayerRole | No | |
Region | form | PlayerRegion | No | |
Username | form | string | No | |
HighScore | form | long | No | |
GamesPlayed | form | long | No | |
Energy | form | int | No | |
ProfileUrl | form | string | No | |
CoverUrl | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Leader | |
Player | |
NonPlayer |
Name | Value | |
---|---|---|
Africa | 1 | |
Americas | 2 | |
Asia | 3 | |
Australasia | 4 | |
Europe | 5 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<Todo> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Text | form | string | Yes | |
IsFinished | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/QueryPlayer HTTP/1.1
Host: blazor-gallery.servicestack.net
Accept: application/json
Content-Type: application/json
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: application/json 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-01T00:00:00","createdBy":"String","modifiedDate":"0001-01-01T00:00:00","modifiedBy":"String","deletedDate":"0001-01-01T00:00:00","deletedBy":"String"},"profileId":0,"savedLevelId":"00000000-0000-0000-0000-000000000000","rowVersion":0,"createdDate":"0001-01-01T00:00:00","createdBy":"String","modifiedDate":"0001-01-01T00:00:00","modifiedBy":"String","deletedDate":"0001-01-01T00:00:00","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"}}}