load_interval
Чтобы загрузить сообщения за определенный интервал в загрузчик сообщений, используйте запрос messages/load_interval:
svc=messages/load_interval¶ms={"itemId":<long>,
"timeFrom":<uint>,
"timeTo":<uint>,
"flags":<uint>,
"flagsMask":<uint>,
"loadCount":<uint>}
Этот запрос нельзя выполнять одновременно со следующими запросами:
- …/report/exec_report,
- …/report/export_result,
- …/report/get_result_chart,
- …/report/get_result_map,
- …/render/create_messages_layer,
- …/unit/get_trips,
- …/resource/get_driver_bindings,
- …/resource/get_trailer_bindings,
- все запросы из раздела exchange,
- …/account/get_account_history.
Использование этого запроса рассмотрено в примере messages.
Параметры
Обязательные параметры отмечены звездочкой (*).
| Параметр | Описание |
|---|---|
| itemId* | ID объекта или ресурса (зависит от типа сообщений, которые нужно получить). |
| timeFrom* | Начало интервала. |
| timeTo* | Конец интервала. |
| flags* | Флаги для загрузки сообщений. См. описание ниже. |
| flagsMask* | Маска. См. описание ниже. |
| loadCount* | Количество сообщений, которые необходимо вернуть (0xffffffff — все найденные). |
Примеры использования масок и флагов сообщений:
| Маска | Флаг | Результат |
|---|---|---|
| 0xFF00 | 0x0000 | Все сообщения с данными. |
| 0xFF10 | 0x0010 | Сообщения с данными, в которых содержится бит тревожного сообщения (0x10). |
| 0xFFF0 | 0x0010 | Сообщения с данными, в которых содержится бит тревожного сообщения (0x10), но не содержится информации о коде водителя (0x20). |
| 0xFFF2 | 0x0022 | Сообщения с данными, в которых содержится информация о коде водителя (0x20) и о входящих данных (0x02), но нет бита тревожного сообщения (0x10). |
| 0xFF01 | 0x0601 | События, которые являются нарушениями. |
Возвращаемый результат
Если запрос выполнен успешно, возвращается следующий ответ:
{
"count":<uint>, /* количество сообщений */
"messages":[ /* массив сообщений */
{
...
}
]
}
Форматы, маски и флаги сообщений рассмотрены здесь.
При неудачном выполнении возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 7 | Не удалось извлечь менеджер сообщений. |
| 6 | Не удалось извлечь сообщения за интервал. |
| 4 | Не удалось извлечь пользователя. |
| 1003 | Accept-encoding не gzip. |