Player Info

From King Arthur's Gold Wiki
Jump to: navigation, search

Implementation Status: Implemented
URI: https://api.kag2d.com/player/$PLAYER/info
HTTP Verbs Supported: GET
Response Type: JSON dictionary
HTTP Auth Required: No


This resource provides basic account information for a user. It may also provide status information similar to Account Status, just in a different format which may be better-suited for certain purposes/clients.

Example

Request: GET /player/FliesLikeABrick/info

{"active": false, "username": "FliesLikeABrick", "banned": false, "role": 4, "gold": true}

Information returned to this call includes (key - description:

  • username - the properly cased/formatted username on record
  • banned - boolean of whether the account is currently global banned
  • role - Account role (regular player, KAG guard, KAG admin/team member/dev)
  • gold - boolean of whether the account is premium

Errors

The resource will return 404 if the user does not exist.