Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 20.8 >
edited by Артем Шемяков
on 2022/09/01 17:44
To version < 22.4 >
edited by Артем Шемяков
on 2022/09/02 10:05
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% lang="en-US" %)
37 37  (% style="color:#000000" %)**Ответ:**
... ... @@ -44,7 +44,7 @@
44 44   "User": "" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 - }
47 +}
48 48  
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
... ... @@ -82,13 +82,13 @@
82 82  
83 83  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
86 86  
87 87  (% style="color:#000000" %)Метод запроса: **GET**
88 88  
89 89  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
91 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
92 92  
93 93  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
... ... @@ -99,14 +99,11 @@
99 99   "parentId": "", ~/~/ идентификатор клиента-родителя
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента1
102 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 103   "status": "", ~/~/ статус клиента
104 - }
104 +}
105 105  
106 106  
107 -(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
108 -
109 -
110 110  (% class="box" style="text-align: center;" %)
111 111  (((
112 112  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -145,13 +145,13 @@
145 145   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 146   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 147   "groups": "" , ~/~/ группы пользователя, названия групп
148 - }
145 +}
149 149  
150 150  (% style="text-align:left" %)
151 151  (% style="color:#000000; font-weight:normal" %)Ответ:
152 152  
153 153  (% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %){
151 +(% style="color:#000000; font-weight:normal" %){    
155 155  
156 156  (% style="text-align:left" %)
157 157  (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
... ... @@ -173,7 +173,7 @@
173 173   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
174 174  
175 175  (% style="text-align:left" %)
176 -(% style="color:#000000; font-weight:normal" %) }
173 +(% style="color:#000000; font-weight:normal" %)}
177 177  
178 178  
179 179  (% class="box successmessage" %)
... ... @@ -198,11 +198,11 @@
198 198   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 199   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
200 200  
201 -(% style="color:#000000" %) }
198 +(% style="color:#000000" %)}
202 202  
203 203  (% style="color:#000000" %)Ответ:
204 204  
205 -(% style="color:#000000" %){ (%%)
202 +(% style="color:#000000" %){         (%%)
206 206  
207 207   "id": "" , ~/~/ идентификатор пользователя
208 208   "lastName": "" , ~/~/ фамилия
... ... @@ -218,7 +218,7 @@
218 218   "status": "1",  ~/~/ статус пользователя
219 219   "astLogged": "", ~/~/ дата/время последней авторизации
220 220  
221 -(% style="color:#000000" %) }
218 +(% style="color:#000000" %)}
222 222  
223 223  
224 224  (% class="box warningmessage" %)
... ... @@ -238,7 +238,7 @@
238 238  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
239 239  
240 240  (% lang="en-US" style="text-align:left" %)
241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
238 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
242 242  
243 243  (% lang="en-US" style="text-align:left" %)
244 244  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
... ... @@ -261,16 +261,16 @@
261 261   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
262 262  
263 263  (% lang="en-US" style="text-align:left" %)
264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
261 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
265 265  
266 266  (% lang="en-US" style="text-align:left" %)
267 267  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
268 268  
269 269  (% lang="en-US" style="text-align:left" %)
270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ //
267 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
271 271  
272 272  (% lang="en-US" style="text-align:left" %)
273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
274 274   "lastName": "" , ~/~/ фамилия
275 275   "firstName": "" , ~/~/ имя
276 276   "position": "" , ~/~/ должность
... ... @@ -286,10 +286,10 @@
286 286   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
287 287   "kind": "" , ~/~/ тип аутентификации
288 288   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
286 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
290 290  
291 291  (% lang="en-US" style="text-align:left" %)
292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
289 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
293 293  
294 294  
295 295  (% class="box warningmessage" %)
... ... @@ -303,7 +303,7 @@
303 303  
304 304  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
305 305  
306 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
303 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
307 307  
308 308  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
309 309  
... ... @@ -315,7 +315,7 @@
315 315   "description": "" , ~/~/ описание
316 316   "data": "" , ~/~/ данные, связанные со сменой статуса
317 317  
318 - (% style="color:#000000" %)}
315 +(% style="color:#000000" %)}
319 319  
320 320  (% style="text-align:left" %)
321 321  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
... ... @@ -370,24 +370,20 @@
370 370  
371 371  (% style="color:#000000" %){
372 372  
373 -(% class="western" %)
374 -{{{ "vehicleId": “”, // идентификатор объекта
375 - "name": "", // имя объекта
376 - "imei": "", // IMEI объекта
377 - "deviceTypeId": “”, // идентификатор устройства объекта
378 - "deviceTypeName": "" // наименование устройства объекта
379 - "parentId": "", // идентификатор клиента-родителя
380 - "parentName": "" // наименование клиента-родителя,
381 - "modelId": "", // идентификатор модели объекта
382 - "modelName": "" // наименование модели объекта,
383 - "unitId": "", // идентификатор подразделения
384 - "unitName": "", // наименование подразделения
385 - "status": “”, // статус объекта
386 - ...
387 - },
388 - ...}}}
370 + "vehicleId": "" , ~/~/ идентификатор объекта
371 + "name": "" , ~/~/ имя объекта
372 + "imei": "" , ~/~/ IMEI объекта
373 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
374 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
375 + "parentId": "" , ~/~/ идентификатор клиента-родителя
376 + "parentName": "" , ~/~/ наименование клиента-родителя,
377 + "modelId": "" , ~/~/ идентификатор модели объекта
378 + "modelName": "" , ~/~/ наименование модели объекта,
379 + "unitId": "" , ~/~/ идентификатор подразделения
380 + "unitName": "" , ~/~/ наименование подразделения
381 + "status": "" , ~/~/ статус объекта
389 389  
390 -(% style="color:#000000" %)}
383 +}
391 391  
392 392  (% style="text-align:left" %)
393 393  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -409,95 +409,92 @@
409 409  
410 410  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
411 411  
412 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
405 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
413 413  
414 -(% class="western" %)
415 -{{{ "parentId": "", // ID клиента
416 - "name": "", // имя ТС
417 - "imei": "", // IMEI
418 - "deviceTypeId": "",// ID типа устройства
419 - "modelId": "",
420 - "unitId": "", // ID подразделения
421 - "sim1": "", // Номер SIM 1
422 - "sim2": "", // Номер SIM2
423 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
424 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
425 - "consumptionIdle": "",// Расход топлива на холостом ходу
426 - "counters": {
427 - "mileage": "", // пробег
428 - "mileageEnabled": true, // флаг активности счётчика "пробег"
429 - "motohours":"", // моточасы
430 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
431 - },
432 - "cmsv6Parameters": { // параметры CMSv6
433 - "enabled": true, // флаг включения
434 - //"id": "", // идентификатор
435 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
436 - "login": "", // имя учетной записи
437 - "password": "" // пароль учетной записи
407 +(% style="color:#000000" %){
408 +
409 + "parentId": "" , ~/~/ ID клиента
410 + "name": "" , ~/~/ имя ТС
411 + "imei": "" , ~/~/ IMEI
412 + "deviceTypeId": "" , ~/~/ ID типа устройства
413 + "modelId": "" , ~/~/ ID модели
414 + "unitId": "" , ~/~/ ID подразделения
415 + "sim1": "" , ~/~/ Номер SIM 1
416 + "sim2": "" , ~/~/ Номер SIM2
417 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
418 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
419 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
420 + "counters": {
421 + "mileage": "" , ~/~/ пробег
422 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
423 + "motohours": "" , ~/~/ моточасы
424 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
438 438   },
439 - "inspectionTasks": [ // задания на ТО
440 - {
441 - "enabled": "", // Признак включения
442 - "name": "", // Имя задания
443 - "description": "", // Описание задания
444 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
445 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
446 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
447 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
448 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
449 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
450 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
451 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
426 + "cmsv6Parameters": { ~/~/ параметры CMSv6
427 + "enabled": true, ~/~/ флаг включения
428 + "id": "" , ~/~/ идентификатор
429 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
430 + "login": "" , ~/~/ имя учетной записи
431 + "password": "" ~/~/ пароль учетной записи
452 452   },
453 - ]}}}
433 + "inspectionTasks": ~/~/ задания на ТО
434 + {
435 + "enabled": "" , ~/~/ Признак включения
436 + "name": "" , ~/~/ Имя задания
437 + "description": "" , ~/~/ Описание задания
438 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
439 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
440 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
441 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
442 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
443 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
444 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
445 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
446 + }
454 454  
455 -(% style="color:#000000" %)… }
448 +(% style="color:#000000" %) }
456 456  
457 457  (% style="color:#000000" %)Ответ:
458 458  
459 459  (% style="color:#000000" %){
460 460  
461 -(% class="western" %)
462 -{{{ "vehicleId": "", //ID ТС
463 - "parentId": "", //Guid владельца ТС
464 - "name": "", //Имя объекта
465 - "imei": "", //IMEI
466 - "deviceTypeId": "", //ID типа устройства
467 - "modelId": "", //ID модели
468 - "unitId": "", //ID подразделения
469 - "sim1": "", //SIM1
470 - "sim2": "", //SIM2
471 - "consumptionPer100Km": "", //Расход топлива на 100 км
472 - "consumptionIdle": "", //Расход топлива на холостом ходу
473 - "counters": { //Счётчики
474 - "mileageEnabled": true,
475 - "motohoursEnabled": true,
476 - "mileage": "",
477 - "motohours": 345.0
478 - },
479 - "cmsv6Parameters": { //Параметры CmsV6
480 - "id": null,
481 - "enabled": true, //флаг включения
482 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
483 - "login": "", // имя учетной записи
484 - "password": "" // пароль учетной записи
485 - },
486 - "inspectionTasks": [ // задания на ТО
487 - {
488 - "id": "", // ID задачи
489 - "enabled": false, // Признак включения
490 - "name": "", // Имя задания
491 - "description": "", // Описание задания
492 - "mileageCondition": "", // Условие по пробегу
493 - "lastMileage": "", // Пробег (в метрах)
494 - "motohoursCondition": "", // Условие по моточасам
495 - "lastMotohours": "", // Моточасы
496 - "periodicCondition": "", // Условие периодичности по времени
497 - "kind": "", // Вид периодичности по времени
498 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
499 - }
500 - ]}}}
454 + "vehicleId": "", ~/~/ID ТС 
455 + "parentId": "", ~/~/Guid владельца ТС
456 + "name": "", ~/~/Имя объекта
457 + "imei": "", ~/~/IMEI
458 + "deviceTypeId": "", ~/~/ID типа устройства
459 + "modelId": "", ~/~/ID модели
460 + "unitId": "", ~/~/ID подразделения
461 + "sim1": "", ~/~/SIM1
462 + "sim2": "", ~/~/SIM2
463 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
464 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
465 + "counters": { ~/~/Счётчики
466 + "mileageEnabled": true,
467 + "motohoursEnabled": true,
468 + "mileage": "",
469 + "motohours": 345.0
470 + },
471 + "cmsv6Parameters": { ~/~/Параметры CmsV6
472 + "id": null,
473 + "enabled": true, ~/~/флаг включения
474 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
475 + "login": "", ~/~/ имя учетной записи
476 + "password": "" ~/~/ пароль учетной записи
477 + },
478 + "inspectionTasks": { ~/~/ задания на ТО
479 + "id": "", ~/~/ ID задачи
480 + "enabled": false, ~/~/ Признак включения
481 + "name": "", ~/~/ Имя задания
482 + "description": "", ~/~/ Описание задания
483 + "mileageCondition": "", ~/~/ Условие по пробегу
484 + "lastMileage": "", ~/~/ Пробег (в метрах)
485 + "motohoursCondition": "", ~/~/ Условие по моточасам
486 + "lastMotohours": "", ~/~/ Моточасы
487 + "periodicCondition": "", ~/~/ Условие периодичности по времени
488 + "kind": "", ~/~/ Вид периодичности по времени 
489 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
490 + }
501 501  
502 502  (% style="text-align:left" %)
503 503  (% style="color:#000000" %)}
... ... @@ -516,11 +516,11 @@
516 516  
517 517  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
518 518  
519 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
509 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
520 520  
521 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
511 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
522 522  
523 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
513 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
524 524  
525 525  (% style="color:#000000" %)Метод запроса: **POST**
526 526  
... ... @@ -534,19 +534,41 @@
534 534  
535 535  (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
536 536  
537 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
527 +(% class="western" style="color:#000000" %)##{##
538 538  
539 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
529 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
530 + "name": null, ~/~/ Имя ТС (string, опционально) 
531 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
532 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
533 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
534 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
535 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
536 +(% style="color:#000000" %)}
540 540  
541 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
538 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
542 542  
543 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
540 +(% style="color:#000000" %)Ответ:
544 544  
545 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
542 +(% style="color:#000000" %){
546 546  
547 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
544 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
545 + "name": "" ~/~/ наименование объекта
546 + "imei": "" ~/~/ IMEI объекта
547 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
548 + "deviceTypeName": "" ~/~/ наименование типа устройства
549 + "sim1": "" ~/~/ первый номер телефона
550 + "sim2": "" ~/~/ второй номер телефона
551 + "parentId": "" ~/~/ идентификатор клиента-родителя
552 + "parentName": "" ~/~/ наименование клиента-родителя
553 + "modelId": "" ~/~/ идентификатор модели объекта
554 + "modelName": "" ~/~/ наименование модели объекта
555 + "unitId": "" ~/~/ идентификатор подразделения
556 + "unitName": "" ~/~/ наименование подразделения
557 + "status": "" ~/~/ статус объекта         
558 + "createdAt": "" ~/~/ дата создания объектов  (%%)
559 +(% style="color:#000000" %)}
548 548  
549 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
561 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
550 550  
551 551  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
552 552  
... ... @@ -566,32 +566,34 @@
566 566  
567 567  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
568 568  
569 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
581 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
570 570  
571 -(% class="western" %)
572 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
573 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
574 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
575 - "date": "", // Дата смены статуса (null если сменить немедленно)
576 - "description": "", // Описание
577 - "data": "", // Данные
578 - "overwrite": false, // Флаг перезаписи
579 - "stage": "", // Состояние, может быть null}}}
583 +(% style="color:#000000" %){
580 580  
585 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
586 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
587 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
588 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
589 + "description": "", ~/~/ Описание
590 + "data": "", ~/~/ Данные
591 + "overwrite": false, ~/~/ Флаг перезаписи
592 + "stage": "", ~/~/ Состояние, может быть null
593 +
581 581  (% style="color:#000000" %)}
582 582  
583 -(% style="color:#000000" %)Ответ: {
596 +(% style="color:#000000" %)Ответ:
584 584  
585 -(% class="western" %)
586 -{{{ "status": "", // значение статуса
587 - "date": "", // Дата смены статуса
588 - "description": "", // Описание
589 - "data": "", // Данные
590 - "overwrite": false, // Флаг перезаписи
591 - "stage": "", // Состояние}}}
598 +(% style="color:#000000" %){
592 592  
600 + "status": "", ~/~/ значение статуса
601 + "date": "", ~/~/ Дата смены статуса 
602 + "description": "", ~/~/ Описание
603 + "data": "", ~/~/ Данные
604 + "overwrite": false, ~/~/ Флаг перезаписи
605 + "stage": "", ~/~/ Состояние
606 +
593 593  (% style="text-align:left" %)
594 -(% style="color:#000000" %)}
608 +(% style="color:#000000" %) }
595 595  
596 596  
597 597  (% class="box warningmessage" %)
... ... @@ -609,14 +609,102 @@
609 609  
610 610  (% style="color:#000000" %)Параметры в теле запроса (JSON):
611 611  
612 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
626 +(% style="color:#000000" %){    
613 613  
628 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
629 + "parentId": "", ~/~/ ID клиента
630 + "name": "", ~/~/ имя ТС
631 + "imei": "", ~/~/ IMEI
632 + "deviceTypeId": "", ~/~/ ID типа устройства
633 + "modelId": "", ~/~/ , ID модели    
634 + "unitId": "", ~/~/ подразделения
635 + "sim1": "", ~/~/ SIM 1
636 + "sim2": "", ~/~/ SIM2
637 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
638 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
639 + "counters": 
640 + {
641 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
642 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
643 + "mileage": «», пробег
644 + "motohours": «» моточасы
645 + }
646 + "cmsv6Parameters": ~/~/ параметры CMSv6
647 + {       
648 + "id": "", ~/~/ идентификатор
649 + "enabled": true, ~/~/ флаг включения
650 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
651 + "login": "", ~/~/ имя учетной записи
652 + "password": "", ~/~/ пароль учетной записи
653 + }
654 + "inspectionTasks": ~/~/ задания на ТО
655 + {
656 + "id": "", ~/~/ ID задания
657 + "enabled": false, ~/~/ Признак включения
658 + "name": "", ~/~/ Имя задания
659 + "description": "", ~/~/ Описание задания
660 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
661 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
663 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
664 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
665 + "kind": "", ~/~/ Вид периодичности по времени
666 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
667 + } 
668 +
669 +(% style="color:#000000" %)}
670 +
614 614  (% style="color:#000000" %)Ответ:
615 615  
616 616  (% lang="en-US" style="text-align:left" %)
617 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
674 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
618 618  
676 +(% lang="en-US" style="text-align:left" %)
677 + "vehicleId": "", ~/~/ ID ТС
678 + "parentId": "", ~/~/ ID клиента
679 + "name": "", ~/~/ имя ТС
680 + "imei": "", ~/~/ IMEI
681 + "deviceTypeId": "", ~/~/ типа устройства
682 + "modelId": "", ~/~/ ID модели
683 + "unitId": "", ~/~/ ID подразделения
684 + "sim1": "", ~/~/ SIM 1
685 + "sim2": "", ~/~/ SIM2
686 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
687 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
688 + "counters": 
689 + {
690 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
691 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
692 + "mileage": "", ~/~/ пробег
693 + "motohours": "", ~/~/ моточасы
694 + }
695 + "cmsv6Parameters": ~/~/ параметры CMSv6
696 + {
697 + "id": ~/~/ идентификатор
698 + "enabled": true, ~/~/ флаг включения
699 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
700 + "login": "", ~/~/ имя учетной записи
701 + "password": "", ~/~/ пароль учетной записи
702 + }
703 + "inspectionTasks": ~/~/ задания на ТО
704 + {
705 + "id": "", ~/~/ ID задания
706 + "enabled": false, ~/~/ Признак включения
707 + "name": "", ~/~/ Имя задания
708 + "description": "", ~/~/ Описание задания
709 + "mileageCondition": "", ~/~/ Условие по пробегу
710 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
711 + "motohoursCondition": "", ~/~/ Условие по моточасам
712 + "lastMotohours": "", ~/~/ Моточасы
713 + "periodicCondition": "", ~/~/ Условие периодичности по времени
714 + "kind": "", ~/~/ Вид периодичности по времени
715 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
716 + }
619 619  
718 +(% lang="en-US" style="text-align:left" %)
719 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
720 +
721 +
620 620  (% class="box errormessage" %)
621 621  (((
622 622  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -654,16 +654,15 @@
654 654  
655 655  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
656 656  
657 -(% style="color:#000000" %)Ответ: [
759 +(% style="color:#000000" %)Ответ:
658 658  
659 -(% class="western" %)
660 -{{{ {
661 - "deviceTypeId" : "", // ID типа устройства
662 - "deviceTypeName" : "" // Название типа устройства
663 - },}}}
761 +(% style="color:#000000" %){
664 664  
763 + "deviceTypeId" : "", ~/~/ ID типа устройства
764 + "deviceTypeName" : "" ~/~/ Название типа устройства
765 +
665 665  (% style="text-align:left" %)
666 -(% style="color:#000000" %)…** **]
767 +(% style="color:#000000" %)}
667 667  
668 668  
669 669  (% class="box" style="text-align: center;" %)
... ... @@ -684,19 +684,16 @@
684 684  
685 685  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
686 686  
687 -(% style="color:#000000" %)Ответ: [
788 +(% style="color:#000000" %)Ответ:
688 688  
689 -(% class="western" style="margin-bottom:19px" %)
690 -{{{ {}}}
790 +(% style="color:#000000" %){
691 691  
692 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
792 + "id": "", ~/~/ ID типа датчика 
793 + "name": "", ~/~/ Название
794 + "description": "", ~/~/ Описание
693 693  
694 -(% class="western" %)
695 -{{{ "description": "" // Описание
696 - },}}}
697 -
698 698  (% style="text-align:left" %)
699 -(% style="color:#000000" %)… ]
797 +(% style="color:#000000" %)}
700 700  
701 701  
702 702  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

ГЛОНАССSoft wiki - 2024 г.