...
Ошибка. Вы получите следующий формат ответа:
| Code Block |
|---|
{
"error": {
"code": 404,
"message": "Not found"
}
} |
| Code Block |
|---|
{
"error": {
"code": 422,
"description": {
"limitation": [
"Limitation for page is missing"
],
"page": [
"Page is missing"
]
},
"message": "Unprocessable entity"
}
} |
Описание ответа:
Поле | Описание |
|---|---|
error.code | HTTP код |
error.message | Описание ошибки |
error.description | Появляется исключительно при статусе 422. Включает в себя название поля в запросе и ошибки которые нужно исправить |
Обновление или запись. Вы получите следующий формат ответа:
| Code Block |
|---|
{
"state": false
} |
Описание ответа:
Поле | Описание |
|---|---|
state | Статус операции. Может принимать значения Boolean. Вернет false в случае неуспешного выполнения или true в ином случае |
...
Чтение. Вы получите следующий формат ответа:
| Code Block | ||
|---|---|---|
| ||
{
"cursor": |
...
Cursor, "collection": |
...
Object[] } |
Описание ответа:
Поле | Описание | |||
|---|---|---|---|---|
cursor.page | Запрашиваемая страница для чтения | cursor.pages | Количество страниц с указанным лимитом на чтение | Объект типа Cursor |
collection | Включает в себя массив Массив запрашиваемых объектов |
Создание / Получение по ID. Вы получите следующий формат ответа:
| Code Block |
|---|
{
"id": 2196,
"name": "Oleksandr Serdiuk",
"image": "https:\/\/messenger.smartsender.eu\/storage\/projects\/1\/TVZhdSAq9XeqMktQSo7f8qZVHnt4vsy5BmnVt8gl.jpeg",
"contact": {
"id": 3404,
"originalId": 2231
},
"gates": [
{
"id": 3404,
"subscribed": true,
"unreadMessages": 0,
"channel": {
"id": 2,
"active": true,
"occupied": true,
"type": "viber",
"name": "smartsender",
"referrer": 1,
"link": "https:\/\/viber.me\/smartsender",
"app": "viber:\/\/pa?chatURI=smartsender",
"createdAt": "2019-08-02 18:26:33",
"updatedAt": "2019-11-25 15:07:43"
}
}
],
"createdAt": "2019-10-23 16:16:38",
"updatedAt": "2019-11-25 21:43:22"
} |
Внимание! Ответ по запросу ID мы не оборачиваем, а отдам сразу JSON результат.. После выполнения данных операций вы получите запрашиваемый/созданный объект noWrap.
| Code Block |
|---|
{...} |