Version 7.8.2

Back | 

WsPlayer

Returns players list for the given account

URL Format

/ws/ws_player/api/{app_token}/mode/json/apiv/5?start={start}&end={end}&type={type}&sortby={sortby}&sortdir={asc/desc}&include_global_players={true/false}

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.
type type filter for player type (static or custom). Possible values => static/custom
include_global_players boolean will include global players. Default is set to false. {true, false}
template_type_id int the template type Id to choose, if more than one, comma seperate

Possible Responses

  • 318 Players Found
  • 1040 Invalid player filter type
  • 1041 Invalid sort params
  • 1042 Players not found
  • 101 Invalid client token.
  • 102 Invalid app token.
  • 659 Invalid Client
  • 913 Global player access is disabled for this account
  • 1051 Invalid Boolean Params
  • 912 Invalid sort direction params

Example Response

{
  "response": {
    "WsPlayerResponse": {
      "player": {
        "mu7x68ps": {
          "id": 1711,
          "uuid": "mu7x68ps",
          "isStatic": 0,
          "templateGroupId": 9,
          "lastModifiedDate": "2013-10-01T14:48:24Z",
          "playerName": "QA Plugin: Presentation Player",
          "swfURL": "{base appstudio url}\/compiled\/mediasuite_73\/AppShell_mu7x68ps.swf?timestamp=1380638903355",
          "jsonURL": "{base url}\/templates\/AppStudio\/CustomPlayer\/7\/3\/73\/mu7x68ps\/mu7x68ps.json",
          "thumbURL": "{baseurl}templates\/AppStudio\/CustomPlayerThumb\/7\/3\/73\/mu7x68ps\/mu7x68ps.jpg",
          "width": 990,
          "height": 500
        }
      },
      "totalCount": "1",
      "currentCount": 1
    }
  }
}