Skip to content
RallyHere Docs
GitHub

Get All Player Id Settings For Setting Type

Deprecated
GET
/settings/v1/player/{player_id}/setting_type/{setting_type_id}/key

Get a list of all player settings for a specific Setting Type.

Required Permissions: setting:read for any player. setting:read:self for the player of the access token.

DEPRECATED - Use v2 instead

Authorizations

  • HTTPBearerHeadersOrCookie

Parameters

Path Parameters

player_id
required

Player to get settings for

integer

Player to get settings for

setting_type_id
required

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

string
>= 1 characters <= 128 characters

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

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

Forbidden

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