opt-cc/server/apib/statistics/players.apib

37 lines
1.9 KiB
Plaintext
Raw Permalink Normal View History

2018-04-01 10:59:09 +02:00
### Get Player Highscore [GET /players/ranking/{campaignId}]
2018-03-31 19:23:49 +02:00
List highscores for player statistics over all wars of a certain campaign.
Every highscore player object contains a field *sum*, representing its order number in the collection
+ Parameters
+ campaignId: `5abd55ea9e30a76bfef747d6` (string, required) - unique id of the campaign
2018-04-01 10:59:09 +02:00
+ Response 200 (application/json; charset=utf-8)
2018-03-31 19:23:49 +02:00
+ Attributes
+ kill (array[HighscorePlayer],required) - player highscore for kill
+ death (array[HighscorePlayer],required) - player highscore for death
+ friendlyFire (array[HighscorePlayer],required) - player highscore for friendly fire
2018-04-15 13:47:48 +02:00
+ vehicleLight (array[HighscorePlayer],required) - player highscore for light vehicle
+ vehicleHeavy (array[HighscorePlayer],required) - player highscore for heavy vehicle
+ vehicleAir (array[HighscorePlayer],required) - player highscore for air vehicle
2018-03-31 19:23:49 +02:00
+ revive (array[HighscorePlayer],required) - player highscore for revive
+ respawn (array[HighscorePlayer],required) - player highscore for respawn
+ flagTouch (array[HighscorePlayer],required) - player highscore for flag captures
2018-04-01 10:59:09 +02:00
### Get Player Campaign Statistics [GET /players/single/{campaignId}/{playerSteamId}]
2018-03-31 19:23:49 +02:00
Get statistics for a single player for all wars of a campaign he took part at
+ Parameters
+ campaignId: `5abd55ea9e30a76bfef747d6` (string, required) - unique id of the campaign
2018-04-01 10:59:09 +02:00
+ playerSteamId: `76561198050321490` (string, required) - STEAM application unique user id of player
2018-03-31 19:23:49 +02:00
2018-04-01 10:59:09 +02:00
+ Response 200 (application/json; charset=utf-8)
2018-03-31 19:23:49 +02:00
+ Attributes
+ name: `Pumarang` (string, required) - latest used playername
+ campaign (Campaign,required) - campaign reflected from request is
2019-02-10 11:01:11 +01:00
+ players (array[HighscorePlayer],required, fixed-type) - collection of player instances in the campaign