Version 8.3.8

Back | 

WsHtml5Player

Returns HTML5 players list for the given account

URL Format

/ws/ws_html5_player/api/{app_token}/mode/json/apiv/5?start={start}&end={end}&type={type}&sortby={playerName/lastModifiedDate}&sortdir={asc/desc}&uuid={uuid}&id={id}&templateGroupId={templateGroupId}&playerName={playerName}

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.
sortby string The column to sort by. Can be {playerName, lastModifiedDate}
sortdir string The sort direction. Can be {asc, desc}
start int Will return a subset of available players. Used primarily for pagination. Default is set to 1
end int Will return a subset of available players. Used primarily for pagination. Default is set to start+20 Zero-based exclusive index: E.G. &start=1&send=4 will return 4 players from the beginning.
uuid string filter for player uuid
id int filter for player id
playerName string filter for player name
include_global_players string filter to include global players. Can be {true,false}
templateGroupId int filter for template Group id

Request Headers

Name

Possible Responses

  • 318 Players Found
  • 1041 Invalid sort params
  • 1042 Players not found
  • 101 Invalid client token.
  • 102 Invalid app token.
  • 659 Invalid Client
  • 912 Invalid sort direction params

Example Response

{
  "response": {
    "success": {
      "code": 318,
      "message": "Players found",
      "details": ""
    },
    "WsHtml5PlayerResponse": {
      "players": [
        {
          "id": 5,
          "playerName": "HTML5 Player",
          "description": "HTML5 Player description",
          "uuid": "s0xngon8",
          "createTime": "2015-09-23T01:30:24Z",
          "clientid": 73,
          "width": 800,
          "height": 450,
          "isDeleted": 0,
          "templateGroupId": 20,
          "lastModifiedUserId": 5320,
          "thumbURL": null
        }
      ],
      "totalCount": 1,
      "currentCount": 1
    }
  }
}