Difference between revisions of "Player Info"
From King Arthur's Gold Wiki
(Created page with "'''Implementation Status:''' Implemented<br/> '''URI:''' https://api.kag2d.com/player/$PLAYER/info<br/> '''HTTP Verbs Supported:''' GET...") |
Prostosuper (Talk | contribs) (→Example) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | '''Implementation Status:''' [[Implemented | + | '''Implementation Status:''' [[API_Implementation_Statuses#Implemented|Implemented]]<br/> |
'''URI:''' https://api.kag2d.com/player/$PLAYER/info<br/> | '''URI:''' https://api.kag2d.com/player/$PLAYER/info<br/> | ||
'''HTTP Verbs Supported:''' GET<br/> | '''HTTP Verbs Supported:''' GET<br/> | ||
| Line 9: | Line 9: | ||
== Example == | == Example == | ||
| − | {"username": "FliesLikeABrick", "banned": false, "gold": true} | + | '''Request:''' GET /player/FliesLikeABrick/info |
| + | {"active": false, "username": "FliesLikeABrick", "banned": false, "role": 4, "gold": true} | ||
| + | |||
| + | Information returned to this call includes (key - description: | ||
| + | <!-- Don't understand, what active key means --> | ||
| + | * 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 == | == Errors == | ||
Latest revision as of 09:24, 26 April 2012
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.
