Directory UI States
Operations related to Directory UI States for managing user interface state and preferences within the platform.
Path parameters
user_idstringRequired
User ID
Responses
200
Success !
application/json
first_resultintegerRequired
max_resultsintegerRequired
statusstring · enumRequiredPossible values:
totalintegerRequired
countintegerRequired
400
Error response
application/json
401
Error response
application/json
403
Error response
application/json
404
Error response
application/json
500
Error response
application/json
503
Error response
application/json
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"
}
]
}Path parameters
user_idstringRequired
User ID
idstringRequired
UiState ID
Responses
200
Success !
application/json
statusstring · enumRequiredPossible values:
400
Error response
application/json
401
Error response
application/json
403
Error response
application/json
404
Error response
application/json
500
Error response
application/json
503
Error response
application/json
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"
}
}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:
400
Error response
application/json
401
Error response
application/json
403
Error response
application/json
404
Error response
application/json
500
Error response
application/json
503
Error response
application/json
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"
}
}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:
400
Error response
application/json
401
Error response
application/json
403
Error response
application/json
404
Error response
application/json
500
Error response
application/json
503
Error response
application/json
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"
}
}Path parameters
user_idstringRequired
User ID
idstringRequired
UiState ID
Responses
200
Success response
application/json
statusstring · enumRequiredPossible values:
400
Error response
application/json
401
Error response
application/json
403
Error response
application/json
404
Error response
application/json
500
Error response
application/json
503
Error response
application/json
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?