export_messages
Чтобы экспортировать в файл сообщения, загруженные в слой или по времени, используйте команду exchange/export_messages.
svc=exchange/export_messages¶ms={"layerName":<text>,
"format":<text>,
"itemId":<long>,
"timeFrom":<uint>,
"timeTo":<uint>,
"compress":<bool>}
Этот запрос нельзя выполнить одновременно с другими запросами из этого раздела, а также со следующими запросами:
- …/report/exec_report,
- …/report/export_result,
- …/report/get_result_chart,
- …/report/get_result_map,
- …/messages/load_interval,
- …/render/create_messages_layer,
- …/unit/get_trips,
- …/resource/get_driver_bindings,
- …/resource/get_trailer_bindings,
- …/account/get_account_history.
Параметры
Обязательные параметры обозначены звездочкой (*).
Имя | Описание |
layerName | Имя слоя с сообщениями. Укажите для экспорта сообщений из слоя. |
itemId | ID объекта. Укажите для экспорта сообщений без загрузки в слой. |
format* | Формат файла: txt, kml, plt, wln, wlb. |
timeFrom | Начало интервала. Укажите для экспорта сообщений без загрузки в слой. |
timeTo | Конец интервала. Укажите для экспорта сообщений без загрузки в слой. |
compress* | Укажите 1, чтобы получить сжатый файл, или 0, чтобы получить файл в несжатом виде. |
Возвращаемый результат
При успешном выполнении запроса возвращается файл в указанном формате.
Если в параметрах запроса содержатся поля itemId, timeFrom, timeTo, format и compress, то по значению поля itemId определяется объект, а затем возвращаются его сообщения от timeFrom до timeTo. Поле layerName в этом случае не учитывается, даже если оно указано в запросе. Если же хотя бы одно из полей temId, timeFrom, timeTo, format, compress отсутствует, то по значению поля layerName определяется слой, затем по слою определяется объект и возвращаются все его сообщения (в этом случае поля timeFrom и timeTo не учитываются). Таким образом, команду можно использовать двумя способами. Для первого необходимы поля itemId, timeFrom, timeTo, format и compress, а для второго — layerName, format и compress.
Если запрос выполнить не удалось, возвращается код ошибки.
Коды ошибок
Код ошибки | Описание |
1 | Неверный или устаревший SID запроса. |
4 | Одна из следующих ошибок:
|
6 | Одна из следующих ошибок:
|
7 | Одна из следующих ошибок:
|
1001 | У объекта нет сообщений за указанный период или за все время. |