API Description
The following endpoints are currently available:
Main types of responses
Mistake. You will receive the following response format:
{
"error": {
"code": 404,
"message": "Not found"
}
}
{
"error": {
"code": 422,
"description": {
"limitation": [
"Limitation for page is missing"
],
"page": [
"Page is missing"
]
},
"message": "Unprocessable entity"
}
}
Answer description:
Field | Description |
---|---|
error.code | HTTP code |
error.description | Appears only with status 422. Includes the name of the field in the request and errors that need to be fixed |
error.message | Error Description |
Update. You will receive the following response format:
{
"state": false
}
Answer description:
Field | Description |
---|---|
state | Operation status. Can take Boolean values. Returns false on failure or true otherwise |
Reading. You will receive the following response format:
Описание ответа:
Field | Description |
---|---|
cursor | Object of type Cursor |
collection | Array of requested objects |
Creation / Receipt. After performing these operations, you will get the requested/created noWrap object.