Skip to content
RallyHere Docs

Get All Player Uuid Settings For Setting Type

GET
/settings/v2/player/{player_uuid}/setting_type/{setting_type_id}/key

Get a list of all player setting documents for a specific Setting Type

Required Permissions:

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

  • For the player themselves : setting:read:self

Authorizations

Parameters

Path Parameters

player_uuid
required

Player to get settings for

string format: uuid

Player to get settings for

setting_type_id
required

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

string

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

Query Parameters

key

Setting Key to get settings for. If not specified, all settings for the setting type will be returned

Array<string>

Setting Key to get settings for. If not specified, all settings for the setting type will be returned

Responses

200

Successful Response

object
key
additional properties

Setting version/value data from a specific setting type/key for a player

object
v
required

Setting Version

integer
value
required

Setting Value document

400

Error Codes:

  • setting_type_not_supported - The setting type is not supported at this time. Contact an administrator
object
auth_success
boolean
default: true
error_code
required
string
desc
required
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
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Error Codes:

  • setting_type_id_not_found - The setting type ID was not found
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string