For the complete documentation index, see llms.txt. This page is also available as Markdown.

Directory UI States

Operations related to Directory UI States for managing user interface state and preferences within the platform.

Search UI States of the user

get
/user/{user_id}/ui_states
Path parameters
user_idstringRequired

User ID

Responses
200

Success !

application/json
first_resultintegerRequired
max_resultsintegerRequired
statusstring · enumRequiredPossible values:
totalintegerRequired
countintegerRequired
get/user/{user_id}/ui_states
GET /v1/user/{user_id}/ui_states HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "first_result": 1,
  "max_results": 1,
  "status": "ok",
  "total": 1,
  "count": 1,
  "data": [
    {
      "id": "text",
      "user_id": "text",
      "organisation_id": "text",
      "state": "text"
    }
  ]
}

Search UI State by Id

get
/user/{user_id}/ui_state/{id}
Path parameters
user_idstringRequired

User ID

idstringRequired

UiState ID

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/user/{user_id}/ui_state/{id}
GET /v1/user/{user_id}/ui_state/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "id": "text",
    "user_id": "text",
    "organisation_id": "text",
    "state": "text"
  }
}

Create new UI State

post
/user/{user_id}/ui_state/{id}
Path parameters
user_idstringRequired

User ID

idstringRequired

UiState ID

Body
idstringRead-onlyRequired
user_idstringRequired
organisation_idstringRequired
statestringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/user/{user_id}/ui_state/{id}
POST /v1/user/{user_id}/ui_state/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "user_id": "text",
  "organisation_id": "text",
  "state": "text"
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "user_id": "text",
    "organisation_id": "text",
    "state": "text"
  }
}

Update UI State

put
/user/{user_id}/ui_state/{id}
Path parameters
user_idstringRequired

User ID

idstringRequired

UiState ID

Body
idstringRead-onlyRequired
user_idstringRequired
organisation_idstringRequired
statestringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/user/{user_id}/ui_state/{id}
PUT /v1/user/{user_id}/ui_state/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "user_id": "text",
  "organisation_id": "text",
  "state": "text"
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "user_id": "text",
    "organisation_id": "text",
    "state": "text"
  }
}

Delete UI State of the user

delete
/user/{user_id}/ui_state/{id}
Path parameters
user_idstringRequired

User ID

idstringRequired

UiState ID

Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/user/{user_id}/ui_state/{id}
DELETE /v1/user/{user_id}/ui_state/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Last updated

Was this helpful?