User Display Settings
List of valid attributes:
Attribute | Description | Specifics |
---|---|---|
date_format | Date Format | Cannot be empty, Must be either yyyy-MM-dd or dd.MM.yyyy |
discarded_at | Date of removal | Null or timestamp, cannot be set |
language | Language | Cannot be empty, Must be either de or en |
resource_id | ID of the record the display settings belong to | Cannot be set |
resource_type | Type of the record the display settings belong to | Cannot 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
Parameter | Description |
---|---|
user_id | The 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
Parameter | Description |
---|---|
user_id | The ID of the user from which to update the display settings |