Calculate V2 Ranks

POST 
/rank/v2/rank:calculate

deprecated

Calculate a rank update on players and persist their new ranks Requires at least two teams, and the players' ranks before the last match was played

Required Permissions: rank:update:any

Request

application/json

Body

required

instance_id Instance Id (string)

Possible values: non-empty and <= 128 characters

ID for the instance the match took place on

rank_id Rank Id (string)required

Possible values: non-empty

ID for the rank type used in this match

match_length_seconds Match Length Seconds (integer)required

How many seconds the match lasted

teams

object[]

required

List of teams that participated in this match

Array [

players

object[]

required

List of CalculatedRank objects that give stats about a specific player from the match

Array [

player_uuid uuidrequired

UUID for this specific player

rank

object

required

Ranked data about a player's skill and confidence levels

mu Mu (number)required

A measure of perceived skill in a player

sigma Sigma (number)required

A measure of how confident we are in the perceived skill (high sigma means low confidence)

custom_data

object

Custom key-value player rank data

property name* string

seconds_in_match Seconds In Match (integer)required

How many seconds this player was in the match

]

team_rank Team Rank (integer)required

Possible values: >= 1

What rank this team came in. 1 indicates victory, and higher values are placements. Matching ranks indicate draws

]

Responses

200

Successful Response

application/json

Schema

Schema

updated_players

object[]

required

List of players and their updated ranks

Array [

player_uuid uuidrequired

UUID for this specific player

rank

object

required

Ranked data about a player's skill and confidence levels

mu Mu (number)required

A measure of perceived skill in a player

sigma Sigma (number)required

A measure of how confident we are in the perceived skill (high sigma means low confidence)

custom_data

object

Custom key-value player rank data

property name* string

rank_id Rank Id (string)required

Possible values: non-empty

ID for this rank

]

Example (from schema)

{
  "updated_players": [
    {
      "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "rank": {
        "mu": 0,
        "sigma": 0,
        "custom_data": {}
      },
      "rank_id": "string"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...