Форматы ответа
Формат ответа регулируется заголовком Accept.
Например: Accept: application/json.
application/json
Для получения данных в формате json необходимо указать в заголовке Accept значение application/json.
Поля ответа
| Наименование | Тип | Описание |
|---|---|---|
| data | array | Результат выполнения вызываемого метода. |
| messages | array | Список сообщений, который может содержать сообщения об ограничениях в возвращаемых данных. Например ограничение возвращаемых данных с определенных складов по причине превышения количества разрешенных запросов. |
| time | float | Время обработки запроса. |
Сообщения
Формат сообщений
| Наименование поля | Тип | Описание |
|---|---|---|
| level | string | Уровень сообщения. |
| code | int | Уникальный код для типа сообщения. |
| text | string | Текст сообщения. |
Уровни сообщений
- info — Какая-либо информация не влияющая на работоспособность API.
- warning — Предупреждение свидетельствующее о каких-либо ограничениях о проблемах связанных со взаимодействием с API в будущем (например: приближение к максимальному количеству запросов, запланированные технические работы, низкая сумма на балансе).
- critical - Важное предупреждение связанное с какими-либо ограничениями во взаимодействии с API (например ограничение выдачи по причине превышения максимального количества запросов).
Максимальное количество разрешенных запросов
| Код | Уровень | Сообщение |
|---|---|---|
| 100 | warning | Приближение количества запросов к максимальному. |
| 200 | critical | Достигнуто максимальное количество запросов. |