Запрос данных

Remote API  > Экспорт данных >

Запрос данных

Previous pageReturn to chapter overviewNext page

Параметры

 

com=export/data

par=export_str

 

{

"id": <text>                 /* ID шаблона отчёта  -обязательный*/

"culture": <int>               /* язык отчёта 1033 en-US  1049 ru_RU -обязательный */

"group_id": <int>               /* ID группы -обязательный */

"from_datetime": <uint>        /* дата и время начала периода  Unixtime -обязательный */

"to_datetime": <uint>          /* дата и время конца периода  Unixtime -обязательный */

"agent_ids": <List<int>>      /* список ID агентов */

"car_ids": <List<int>>        /* список ID машин */

"status_ids": <List<int>>     /* список статусов задач */

"zone_ids": <List<int>>       /* список ID геозон */

"sensor_ids": <List<int>>   /* список названий датчиков */

"minSecBetween": <int>         /* минимальный интервал между точками, секунды */

"taskServRadius": <int>        /* допустимый радиус обслуживания задачи, метры */

}

 

Параметры "agent_ids","car_ids","status_ids","zone_ids","sensor_ids" нужны, если в списке отчетов они указаны в поле "param". Если их не указать, это означает - все, т.е. ahent_ids=null значит все агенты.

Параметры "from_datetime","to_datetime" задают период запроса. Он не должен быть больше 1 недели иначе придет ответ

{"com":"export\/data","mes":"The request period is more than a week","res":"MES"}.

Параметр "status_ids" содержит перечень статусов задач. В некоторых отчетах они могут понадобиться.

 

{

free = 0,  /* свободная задача, не назначенная на рейс */

planing = 10, /* задача назначена на рейс */

complete = 90, /* задача выполнена */

broken = 100, /* задача провалена */

 

/* следующие статусы только если используется мобильное приложение Agent LiW */

 

rejected = 20, /* для мобильного приложения. Агент отказался выполнять задачу */

borse = 30,/* для мобильного приложения. Задача отправлен а на биржу        */

sended = 40, /* задача назначена на рейс и отправлена агенту  */

accepted = 50, /* агент получил задачу и принял к исполнению */

moveto = 70, /*  агент выехал к месту задачи */

started = 80, /*  агент  прибыл и начал выполнение */

}

 

 

Пример запроса

 

par={

 "id": "1F99F9FF-D23D-42B0-9FB4-CF7D3EF1C803",

 "culture": 1033,

 "group_id": 1,

 "from_datetime": 1614124800,

 "to_datetime": 1614211200,

 "agent_ids": [    1,    2  ],

 "car_ids": [    1,    2  ],

 "status_ids": [    0,    10,    20,    80,    90,    100

 ],

 "zone_ids": null,

 "sensor_ids": null,

 "minSecBetween": 0,

 "taskServRadius": 0

}

 

Возвращенный результат

 

"com":"export/data",

"res":"OK",

"data":"b0899f36-fbf3-413d-9260-dd16e6c4434b",  /* ид запроса. В дальнейшем все функции работают с ним*/

"mes":"{"id":"1F99F9FF-D23D-42B0-9FB4-CF7D3EF1C803","culture":1033,"group_id":1, "from_datetime":1614297600,"to_datetime":1614384000,"agent_ids": [1,2], "car_ids":[1,2], "status_ids":[0,10,20,80,90,100],"zone_ids":null,"sensor_ids":null,"minSecBetween":0, "taskServRadius":0}",

}

 

В поле  "data":"b0899f36-fbf3-413d-9260-dd16e6c4434b",  содержится  ид запроса. В дальнейшем все функции работают с ним ( не путать с ид шаблона отчета ).

В поле  "mes" возвращается значение параметра переданное в вызове, для контроля и отладки.

Одновременно может выполнаться не более одного запроса на экспорт. Если попытаться запустить еще один до окончания первого, API вернет сообщение

{"com":"export\/data","mes":"The report is already running for your company.","res":"MES"}