Skip to content

User Display Settings

List of valid attributes:

AttributeDescriptionSpecifics
date_formatDate FormatCannot be empty, Must be either yyyy-MM-dd or dd.MM.yyyy
discarded_atDate of removalNull or timestamp, cannot be set
languageLanguageCannot be empty, Must be either de or en
resource_idID of the record the display settings belong toCannot be set
resource_typeType of the record the display settings belong toCannot be set

Show

This endpoint returns JSON structured like this:

{
"data": {
"id": "67ac4d91-1883-47f8-a9a1-f379bbd29cce",
"type": "display_settings",
"attributes": {
...
}
}
}

This endpoint returns the user’s display settings. Each user can only read their own settings.

HTTP Request

GET /api/v1/users/:user_id/display_settings

URL Parameters

ParameterDescription
user_idThe ID of the user from which to return the display settings

Update

Example request:

{
"data": {
"type": "display_settings",
"attributes": {
"date_format": "dd.MM.yyyy",
"language": "de"
}
}
}

Example response:

{
"data": {
"id": "67ac4d91-1883-47f8-a9a1-f379bbd29cce",
"type": "display_settings",
"attributes": {
...
}
}
}

This endpoint updates the user’s display settings. Each user can only update their own settings.

HTTP Request

PUT /api/v1/users/:user_id/display_settings

URL Parameters

ParameterDescription
user_idThe ID of the user from which to update the display settings