Difference between revisions of "Account Status"
From King Arthur's Gold Wiki
(Created page with "Category:API Implementation Status: Planned The status of a KAG account can be fetched from https://api.kag2d.com/account/status This will contain a JSON dictionary with t...") |
m |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:API]] | [[Category:API]] | ||
| − | Implementation Status: Planned | + | Implementation Status: [[API_Implementation_Statuses#Planned|Planned]] |
The status of a KAG account can be fetched from https://api.kag2d.com/account/status | The status of a KAG account can be fetched from https://api.kag2d.com/account/status | ||
| Line 16: | Line 16: | ||
|style="border-style: solid; border-width: 0 1px 0 0"|Integer | |style="border-style: solid; border-width: 0 1px 0 0"|Integer | ||
|style="border-style: solid; border-width: 0 0 0 0"|The account's gold/premium as well as banned status. Current values are additive binary fields. Additional values may be added, so plan accordingly in consumption code. | |style="border-style: solid; border-width: 0 0 0 0"|The account's gold/premium as well as banned status. Current values are additive binary fields. Additional values may be added, so plan accordingly in consumption code. | ||
| − | 1: Active<br/> | + | '''1''': Active<br/> |
| − | 2: Gold<br/> | + | '''2''': Gold<br/> |
| − | 4: Globally Banned<br/> | + | '''4''': Globally Banned<br/> |
| − | Examples: | + | Examples:<br/> |
| − | 0: Inactive<br/> | + | '''0''': Inactive<br/> |
| − | 3: Active and Gold<br/> | + | '''3''': Active and Gold<br/> |
| − | 5: Active and Banned<br/> | + | '''5''': Active and Banned<br/> |
| − | 7: Active and Gold and Banned<br/> | + | '''7''': Active and Gold and Banned<br/> |
|- | |- | ||
|style="border-style: solid; border-width: 1px 1px 0 0"|currentStatus | |style="border-style: solid; border-width: 1px 1px 0 0"|currentStatus | ||
|style="border-style: solid; border-width: 1px 1px 0 0"|Integer | |style="border-style: solid; border-width: 1px 1px 0 0"|Integer | ||
| − | |style="border-style: solid; border-width: 1px 0 0 0"|Whether the player is online or not. Additive binary fields/bitstring<br/> | + | |style="border-style: solid; border-width: 1px 0 0 0"|Whether the player is online or not. Additive binary fields/bitstring, so if the player is online and playing the value would be '''3'''<br/> |
| − | 1: Online<br/> | + | '''1''': Online<br/> |
| − | 2: Playing<br/> | + | '''2''': Playing<br/> |
|- | |- | ||
| Line 37: | Line 37: | ||
|style="border-style: solid; border-width: 1px 0 0 0"|IPv4 and/or IPv6 address and port of the server the player is currently in. If the player is offline or otherwise not in a server, this will be the server they were last seen on. A dictionary will be returned with the IPv4 and/or IPv6 address of the server (with keys IPv4 and IPv6). If other server details are desired, they should be requested from the [[Server Status]] resource | |style="border-style: solid; border-width: 1px 0 0 0"|IPv4 and/or IPv6 address and port of the server the player is currently in. If the player is offline or otherwise not in a server, this will be the server they were last seen on. A dictionary will be returned with the IPv4 and/or IPv6 address of the server (with keys IPv4 and IPv6). If other server details are desired, they should be requested from the [[Server Status]] resource | ||
|} | |} | ||
| + | |||
| + | == See Also == | ||
| + | * [[Player Info]] | ||
Latest revision as of 22:06, 12 March 2012
Implementation Status: Planned
The status of a KAG account can be fetched from https://api.kag2d.com/account/status
This will contain a JSON dictionary with the following keys:
| Key | Data Type | Description/Values |
|---|---|---|
| accountStatus | Integer | The account's gold/premium as well as banned status. Current values are additive binary fields. Additional values may be added, so plan accordingly in consumption code.
1: Active |
| currentStatus | Integer | Whether the player is online or not. Additive binary fields/bitstring, so if the player is online and playing the value would be 3 1: Online |
| currentServer | Dictionary, two strings and an Integer (IPv4, IPv6 and port) | IPv4 and/or IPv6 address and port of the server the player is currently in. If the player is offline or otherwise not in a server, this will be the server they were last seen on. A dictionary will be returned with the IPv4 and/or IPv6 address of the server (with keys IPv4 and IPv6). If other server details are desired, they should be requested from the Server Status resource |
