...
Основные типы ответов
Ошибка. Вы получите следующий формат ответа:
| 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": {
"page": 1,
"pages": 468
},
"collection": [
{
"id": 287,
"photo": "https:\/\/console.smartsender.eu\/img\/avatar-def.png",
"phone": "380950001111",
"email": "serdiuk@smartsender.eu",
"state": "active",
"lastName": "Serdiuk",
"fullName": "Oleksandr Serdiuk",
"firstName": "Oleksandr",
"tags": [
{
"id": 1,
"name": "tag1",
"color": "#fa8123"
},
{
"id": 2,
"name": "tag2",
"color": "#fa5252"
}
],
"funnels": [
{
"id": 1,
"name": "Demo"
}
],
"variables": [
{
"id": 1,
"name": "bonuses",
"content": {
"type": "number",
"resource": {
"default": "0"
}
},
"description": "Bonuses amount",
"createdAt": "2019-10-31 18:12:12",
"updatedAt": "2019-10-31 18:12:12",
"value": "100"
},
]
}
]
} |
Описание ответа:
Поле | Описание |
|---|---|
cursor.page | Запрашиваемая страница для чтения |
cursor.pages | Количество страниц с указанным лимитом на чтение |
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 результат.