|
|
ru:local:remoteapi1604:apiref:messages:load_interval [29/11/2013 13:31] |
ru:local:remoteapi1604:apiref:messages:load_interval [29/11/2013 13:31] (текущий) |
| ====== Загрузить сообщения за интервал ====== |
| Чтобы загрузить сообщения за определенный интервал в загрузчик сообщений, нужно использовать команду **messages/load_interval**: |
| <code javascript> |
| svc=messages/load_interval¶ms={"itemId":<long>, |
| "timeFrom":<uint>, |
| "timeTo":<uint>, |
| "flags":<uint>, |
| "flagsMask":<uint>, |
| "loadCount":<uint>} |
| </code> |
| |
| :!: Данный запрос не может одновременно выполняться со следующими запросами: |
| * [[../report/exec_report|report/exec_report]], |
| * [[../report/export_result|report/export_result]], |
| * [[../report/get_result_chart|report/get_result_chart]], |
| * [[../report/get_result_map|report/get_result_map]], |
| * [[../render/create_messages_layer|render/create_messages_layer]], |
| * [[../unit/get_trips|unit/get_trips]], |
| * [[../resource/get_driver_bindings|resource/get_driver_bindings]], |
| * [[../resource/get_trailer_bindings|resource/get_trailer_bindings]], |
| * все запросы из раздела [[../exchange/exchange]] , |
| * [[../account/get_account_history|account/get_account_history]]. |
| |
| :!: Использование данного запроса рассмотрено в примере [[../../codesamples/messages]]. |
| |
| ===== Параметры ===== |
| ^ Название ^ Описание ^ |
| | itemId | ID объекта или ресурса (зависит от типа сообщений которые нужно получить) | |
| | timeFrom | начало интервала | |
| | timeTo | окончание интервала | |
| | flags | флаги (см. ниже) | |
| | flagsMask | маска (см. ниже) | |
| | loadCount | количество сообщений, которое будет возвращено (0xffffffff - все найденные) | |
| |
| **Примеры использования масок и флагов сообщений:** |
| |
| ^ Маска ^ Флаг ^ Результат ^ |
| | 0xFF00 | 0x0000 | все сообщения с данными | |
| | 0xFF10 | 0x0010 | сообщения с данными, в которых содержится тревожный бит | |
| | 0xFFF0 | 0x0010 | сообщения с данными, в которых содержится тревожный бит(0x10), но не содержит информацию о коде водителя(0x20) | |
| | 0xFFF2 | 0x0022 | сообщения с данными, которые содержит информацию о коде водителя(0x20) и в которых доступна информация о входящих данных(0x02), но эти сообщения не содержат тревожный бит(0x10) | |
| | 0xFF01 | 0x0601 | события, которые являются нарушениями | |
| |
| |
| Все возможные флаги сообщений рассмотрены в разделе [[../format/messages | Форматы данных: Сообщения]]. |
| |
| ===== Возвращаемый результат ===== |
| <code=javascript> |
| { |
| "count":<uint>, /* количество сообщений */ |
| "messages":[ /* массив сообщений */ |
| { |
| ... |
| } |
| ] |
| } |
| </code> |
| |
| Форматы сообщений рассмотрены в разделе [[../format/messages | Форматы данных: Сообщения]]. |