Get Single Player Uuid Setting

GET 
/settings/v2/player/:player_uuid/setting_type/:setting_type_id/key/:key

Get a single player setting document

Required Permissions:

• For any player (including themselves) any of: setting:*:*, setting:read

• For the player themselves : setting:read:self

Request

Path Parameters

player_uuid uuidrequired

Player to get settings for

setting_type_id Setting Type Idrequired

Setting Type to get settings for. Must be one of the known setting types

key Keyrequired

Setting Key to get settings for

Header Parameters

if-match any

Precondition check if the resource's current ETag matches the provided values. * can be used to match any existing value.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-match for more information

if-none-match any

Precondition check if the resource's current ETag does NOT match the provided values. * can be used to match existing value, causing the request to fail.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-none-match for more information

if-modified-since any

Precondition check if the resource's Last-Modified date is newer than the provided date. Ignored if the If-None-Match header is provided. Only valid for GET/HEAD endpoints.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-modified-since for more information

if-unmodified-since any

Precondition check if the resource's Last-Modified date is older than the provided date. Ignored if the If-Match header is provided.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-unmodified-since for more information

Responses

200

Successful Response

Response Headers

• ETag

  string

  The ETag for the resource. Used for caching and preconditions.

• Last-Modified

  string

  The Last-Modified date for the resource. Used for caching and preconditions.

application/json

Schema

Schema

v V (integer)required

Version of the Setting Type schema that was used to validate the value document.

value Valuerequired

Setting Value document

etag

object

ETag identifying the current version+value of the document

anyOf

MOD1

string

last_modified

object

Timestamp when this setting was last modified

anyOf

Time Zone Aware Datetime

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

string

Example (from schema)

{
  "v": 0,
  "etag": "string",
  "last_modified": "2023-01-23T21:07:02.000000+00:00"
}

304

The resource has not been modified from the provided preconditions.

Response Headers

• ETag

  string

  The ETag for the resource. Used for caching and preconditions.

• Last-Modified

  string

  The Last-Modified date for the resource. Used for caching and preconditions.

400

Error Codes:

• setting_type_not_supported - The setting type is not supported at this time. Contact an administrator

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"
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

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"
}

404

Error Codes:

• setting_type_id_not_found - The setting type ID was not found

• not_found - The setting key was not found

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"
}

412

The resource does not meet the provided preconditions.

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