Get All Player Deserters

GET 
/session/v1/player/:player_uuid/deserter

Get a specific player's deserter status

Request

Path Parameters

player_uuid uuidrequired

Responses

200

Successful Response

application/json

Schema

Schema

deserter_statuses

object[]

required

List of all of a player's deserter statuses.

Array [

deserter_id Deserter Id (string)required

ID for which type of deserter this is

deserter_status Deserter Status (boolean)required

Flag of whether or not the player is a deserter

deserter_expiration date-time

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

deserter_reset date-time

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

deserter_count Deserter Count (integer)

Default value: 0

The number of times a player has deserted before the expiration

last_updated date-time

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

custom_data

object

Custom data about a players desertion status

property name* string

]

Example (from schema)

{
  "deserter_statuses": [
    {
      "deserter_id": "string",
      "deserter_status": true,
      "deserter_expiration": "2024-07-29T15:51:28.071Z",
      "deserter_reset": "2024-07-29T15:51:28.071Z",
      "deserter_count": 0,
      "last_updated": "2024-07-29T15:51:28.071Z",
      "custom_data": {}
    }
  ]
}

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...