Get
/v{version}/Locations/AdditionalData/Definitions
Returns the additional data definitions (schema/metadata) for locations, not the actual values. Use GET /Locations//AdditionalData to retrieve the values for a specific location. Edit levels determine the permission scope for modifying an attribute (e.g., which role is allowed to edit it).
Security
API Key: api_key
Header parameter nameX-ApiKey
Api Key
API Key: session_id
Header parameter nameX-Session-Id
Session Id
Path parameters
version
stringRequired
The requested API version
Query parameters
editLevels
array of
One or more edit levels to filter the definitions by. If not specified, all definitions for the user's customer are returned.
Responses
200
Returns the list of additional data definitions matching the specified edit level(s).
Array of object
object
Location attribute
EditLevel
string
Valid values[
"Player",
"Location",
"PlayerAndLocation"
]
Id
integer (int32)
Unique ID of the additional data
Label
string
Label of the additional data
Type
string
Type of location attribute (text, list, bool, etc.)
400
Bad request
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401
Unauthorized
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403
Access denied
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500
Unexpected error
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties