Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 127.1 >
edited by Илья Крайнов
on 2023/11/29 10:51
To version < 190.1 >
edited by Андрей Калиновский
on 2024/11/22 14:55
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -1,5 +1,17 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 +(% class="box warningmessage" %)
4 +(((
5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 +просим вас соблюдать несколько простых правил при использовании API-команд:##
7 +)))
8 +
9 +* Формировать не более 3 отчётов одновременно.
10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11 +
12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд.
13 +
14 +
3 3  **Содержание страницы:**
4 4  )))
5 5  
... ... @@ -14,11 +14,20 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
29 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
31 +
32 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
33 +
34 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
35 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
38 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
39 +(((
40 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
41 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
42 +)))
22 22  
23 23  (% class="box successmessage" %)
24 24  (((
... ... @@ -44,12 +44,8 @@
44 44  
45 45  (% lang="en-US" %)
46 46  (% style="color:#000000" %){
47 -
48 -(% lang="en-US" %)
49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 - "User": "testuser" , ~/~/ имя пользователя
51 -
52 -(% lang="en-US" %)
68 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
69 + "User": "testuser" , ~/~/ имя пользователя(%%)
53 53  }
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
... ... @@ -60,6 +60,9 @@
60 60  |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 61  |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 62  
80 +(% class="wikigeneratedid" %)
81 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
82 +
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -173,7 +173,6 @@
173 173  {
174 174   "agentId": "",(% style="color:#000000" %)   (%%)
175 175   "parentId": "",
176 - "parentName": "string",
177 177   "name": "string",
178 178   "fullName": "string",
179 179   "agentInfoType": 0,
... ... @@ -184,7 +184,6 @@
184 184  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 185  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 186  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 188  |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 189  |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 190  |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
... ... @@ -228,7 +228,6 @@
228 228   "bankKS": "string" ~/~/ корр. счёт
229 229  }
230 230  
231 -
232 232  Ответ:
233 233  
234 234  {
... ... @@ -422,7 +422,6 @@
422 422   ],
423 423   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
424 424  }
425 -
426 426  {
427 427   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
428 428   "lastName": "string",
... ... @@ -436,12 +436,8 @@
436 436  
437 437  (% style="text-align:left" %)
438 438  (% style="color:#000000; font-weight:normal" %)Ответ:
439 -
440 -(% style="text-align:left" %)
441 -(% style="color:#000000; font-weight:normal" %){    
442 -
443 -(% style="text-align:left" %)
444 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
455 +{     
456 + "id": "" , ~/~/ ID пользователя
445 445   "lastName": "" , ~/~/ Фамилия ,
446 446   "firstName": "" , ~/~/ Имя
447 447   "position": "" , ~/~/ Должность
... ... @@ -458,11 +458,9 @@
458 458   "kind": "" , ~/~/ тип аутентификации
459 459   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
460 460   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
473 +}
461 461  
462 -(% style="text-align:left" %)
463 -(% style="color:#000000; font-weight:normal" %)}
464 464  
465 -
466 466  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
467 467  
468 468  (% class="box infomessage" %)
... ... @@ -482,19 +482,16 @@
482 482  
483 483  (% style="color:#000000" %)Параметры в теле запроса (JSON):
484 484  
485 -(% style="color:#000000" %){
486 -
495 +(% style="color:#000000" %){(%%)
487 487   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
488 488   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
489 489   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
490 490   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
491 -
492 492  (% style="color:#000000" %)}
493 493  
494 494  (% style="color:#000000" %)Ответ:
495 495  
496 496  (% style="color:#000000" %){         (%%)
497 -
498 498   "id": "" , ~/~/ идентификатор пользователя
499 499   "lastName": "" , ~/~/ фамилия
500 500   "firstName": "" , ~/~/ имя
... ... @@ -508,7 +508,6 @@
508 508   "sessionDuration":"", ~/~/ длительность сессии в минутах
509 509   "status": "1",  ~/~/ статус пользователя
510 510   "lastLogged": "", ~/~/ дата/время последней авторизации
511 -
512 512  (% style="color:#000000" %)}
513 513  
514 514  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -582,10 +582,8 @@
582 582  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
583 583  
584 584  (% lang="en-US" style="text-align:left" %)
585 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
586 -
587 -(% lang="en-US" style="text-align:left" %)
588 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
591 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
592 + "id": "" , ~/~/ ID пользователя 
589 589   "lastName": "" , ~/~/ фамилия
590 590   "firstName": "" , ~/~/ имя
591 591   "position": "" , ~/~/ должность
... ... @@ -607,9 +607,7 @@
607 607   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
608 608   },
609 609   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
610 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
611 -
612 -(% lang="en-US" style="text-align:left" %)
614 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
613 613  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
614 614  
615 615  (% lang="en-US" style="text-align:left" %)
... ... @@ -616,10 +616,8 @@
616 616  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
617 617  
618 618  (% lang="en-US" style="text-align:left" %)
619 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
620 -
621 -(% lang="en-US" style="text-align:left" %)
622 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
621 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
622 + "id": "" , ~/~/ идентификатор пользователя
623 623   "lastName": "" , ~/~/ фамилия
624 624   "firstName": "" , ~/~/ имя
625 625   "position": "" , ~/~/ должность
... ... @@ -640,10 +640,8 @@
640 640   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
641 641   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
642 642   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
643 +}
643 643  
644 -(% lang="en-US" style="text-align:left" %)
645 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
646 -
647 647  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
648 648  
649 649  (% class="box warningmessage" %)
... ... @@ -663,12 +663,10 @@
663 663  
664 664  (% style="color:#000000" %)Параметры в теле запроса (JSON):
665 665  
666 -(% style="color:#000000" %){
667 -
664 +(% style="color:#000000" %){(%%)
668 668   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
669 669   "description": "" , ~/~/ описание
670 670   "data": "" , ~/~/ данные, связанные со сменой статуса
671 -
672 672  (% style="color:#000000" %)}
673 673  
674 674  (% style="text-align:left" %)
... ... @@ -690,7 +690,7 @@
690 690  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
691 691  
692 692   [ 
693 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
689 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
694 694   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
695 695   ]
696 696  
... ... @@ -996,7 +996,7 @@
996 996  
997 997  Ответ: В случае успеха **Success 200**
998 998  
999 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1000 1000  
1001 1001  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1002 1002  
... ... @@ -1032,19 +1032,15 @@
1032 1032   "deviceTypeName": "", ~/~/ Название типа устройства
1033 1033   "sim1": "", ~/~/ Номер SIM1
1034 1034   "sim2": "", ~/~/ Номер SIM2
1035 -
1036 1036   "parentId": "", ~/~/ ID клиента-родителя
1037 1037   "parentName": "", ~/~/ Наименование клиента-родителя
1038 1038   "modelId": "", ~/~/ ID модели объекта
1039 1039   "modelName": "", ~/~/ Имя модели объекта
1040 -
1041 1041   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1042 1042   "unitName": "string", ~/~/ Наименование подразделения
1043 1043   "status": 0, ~/~/ Статус объекта
1044 -
1045 1045   "createdAt": "", ~/~/ Дата создания объекта
1046 1046   },
1047 -
1048 1048  "customFields": [ ~/~/ Произвольные поля
1049 1049   {
1050 1050   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -1067,8 +1067,7 @@
1067 1067   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1068 1068   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1069 1069   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1070 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
1071 -
1062 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1072 1072   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1073 1073   "mileageCoeff": 0, ~/~/ коэффициент пробега
1074 1074   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -1098,7 +1098,6 @@
1098 1098   "retries": 0 ~/~/ Количество попыток
1099 1099   }
1100 1100   ],
1101 -
1102 1102   "sensors": [ ~/~/ Датчики
1103 1103   {
1104 1104   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -1139,31 +1139,19 @@
1139 1139   },
1140 1140  
1141 1141  ~/~/ Характерные для произвольного:
1142 -
1143 1143  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1144 -
1145 1145  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1146 -
1147 1147  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1148 -
1149 1149  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1150 -
1151 1151  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1152 -
1153 1153  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1154 -
1155 1155  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1156 -
1157 1157  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1158 -
1159 1159  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1160 -
1161 1161  ~/~/ "ValueOn": "Вкл.",
1162 -
1163 1163  ~/~/ "ValueOff": "Выкл."
1164 1164   "summaryMaxValue": 0 ~/~/ Макс. значение
1165 1165   }
1166 -
1167 1167   "drivers": [ ~/~/ Водители
1168 1168   {
1169 1169   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1172,7 +1172,6 @@
1172 1172   "isDefault": true ~/~/ По умолчанию
1173 1173   }
1174 1174   ],
1175 -
1176 1176   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1177 1177   {
1178 1178   "id": "", ~/~/ ID  задания
... ... @@ -1189,8 +1189,7 @@
1189 1189   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1190 1190   }
1191 1191   ],
1192 -
1193 - "statusHistory": [ ~/~/ История статусов
1169 +"statusHistory": [ ~/~/ История статусов
1194 1194   {
1195 1195   "status": 0,
1196 1196   "date": "2023-05-22T09:57:39.562Z",
... ... @@ -1198,7 +1198,6 @@
1198 1198   "additionalInfo": "string"
1199 1199   }
1200 1200   ]
1201 -
1202 1202  }
1203 1203  )))
1204 1204  
... ... @@ -1208,6 +1208,73 @@
1208 1208  (% style="text-align:left" %)
1209 1209  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1210 1210  
1186 +
1187 +== **Отправить команду на терминал** ==
1188 +
1189 +(% class="box successmessage" %)
1190 +(((
1191 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1192 +)))
1193 +
1194 +Команда для отправки на тс.
1195 +
1196 +{  
1197 +"id": "", ~/~/идентификатор произвольного поля
1198 +"command": "", ~/~/ Текст команды
1199 +"retries": "", ~/~/ Количество попыток
1200 +"idTemplate": "" ~/~/ ID шаблона команды
1201 +}
1202 +
1203 +
1204 +== **Получить ответ на отправленную на ТС команду** ==
1205 +
1206 +(% class="box infomessage" %)
1207 +(((
1208 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1209 +)))
1210 +
1211 +Идентификатор команды: cmdid
1212 +
1213 +Запрос от терминала на ответ команды
1214 +
1215 +Пример ответ от терминала:
1216 +
1217 +ID= "" ~/~/ идентификатор произвольного поля
1218 +Soft="" ~/~/ версия софта
1219 +GPS=4 ~/~/ тип трекера
1220 +Time=11:05:43 28.06.24 ~/~/ время запроса
1221 +Lat=45.056221 ~/~/ широта
1222 +Lon=39.035938 ~/~/ долгота
1223 +Speed=0.0 ~/~/ скорость
1224 +Course=181.4 ~/~/направление
1225 +
1226 +(((
1227 +== **Список отправленных объекту команд с ответами** ==
1228 +
1229 +(% class="box infomessage" %)
1230 +(((
1231 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1232 +)))
1233 +
1234 +Идентификатор ТС: vehicleId
1235 +
1236 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1237 +
1238 +Пример ответа терминала
1239 +
1240 +[ 
1241 +{    
1242 +"id": "", ~/~/ идентификатор пользователя
1243 +"commandText": "", ~/~/Текст команды.
1244 +"templateId": "", ~/~/Идентификатор шаблона
1245 +"updated": "", ~/~/ Время отправки  
1246 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1247 +"answer": "", ~/~/ Ответ терминала.
1248 +"status": "" ~/~/ Статус отправки
1249 +}
1250 +]
1251 +)))
1252 +
1211 1211  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1212 1212  
1213 1213  (% class="box successmessage" %)
... ... @@ -1225,8 +1225,7 @@
1225 1225  
1226 1226  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1227 1227  
1228 -(% style="color:#000000" %){
1229 -
1270 +(% style="color:#000000" %){(%%)
1230 1230   "parentId": "" , ~/~/ ID клиента
1231 1231   "name": "" , ~/~/ имя ТС
1232 1232   "imei": "" , ~/~/ IMEI
... ... @@ -1247,7 +1247,6 @@
1247 1247   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1248 1248   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1249 1249   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1250 -
1251 1251   "mileageCalcMethod": 0,
1252 1252   "mileageCoeff": 0,
1253 1253   "locationByCellId": true,
... ... @@ -1280,7 +1280,6 @@
1280 1280   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1281 1281   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1282 1282   }
1283 -
1284 1284  "drivers": [ ~/~/ Водители
1285 1285   {
1286 1286   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1295,8 +1295,7 @@
1295 1295   "retries": 0
1296 1296   }
1297 1297   ],
1298 -
1299 - "sensors": [ ~/~/ Датчики
1337 +"sensors": [ ~/~/ Датчики
1300 1300   {
1301 1301   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1302 1302   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1334,41 +1334,43 @@
1334 1334   "additionalProp2": "string",
1335 1335   "additionalProp3": "string"
1336 1336   },
1337 -
1338 1338  ~/~/ Характерные для произвольного:
1339 -
1340 1340  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1341 -
1342 1342  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1343 -
1344 1344  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1345 -
1346 1346  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1347 -
1348 1348  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1349 -
1350 1350  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1351 -
1352 1352  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1353 -
1354 1354  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1355 -
1356 1356  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1357 -
1358 1358  ~/~/ "ValueOn": "Вкл.",
1359 -
1360 1360  ~/~/ "ValueOff": "Выкл."
1361 - "summaryMaxValue": 0 ~/~/ Макс. значение
1387 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1388 +
1389 +(((
1390 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1391 + {
1392 + "from": 0, ~/~/ С какого значения
1393 + "color": "string", ~/~/ Каким цветом
1394 + "text": "string" ~/~/ Текст подписи к этому интервалу
1395 + }
1396 + ]
1362 1362   }
1363 1363   ],
1399 +)))
1400 +
1401 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1402 +
1403 +
1364 1364   "customFields": [ ~/~/ Произвольные поля
1365 1365   {
1366 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1367 - "name": "string",
1368 - "value": "string",
1369 - "forClient": true,
1370 - "forTooltip": true,
1371 - "forReport": true
1406 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1407 + "name": "string", ~/~/ Наименование произвольного поля
1408 + "value": "string", ~/~/ Значение произвольного поля
1409 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1410 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1411 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1372 1372   }
1373 1373   ]
1374 1374  }
... ... @@ -1375,62 +1375,240 @@
1375 1375  
1376 1376  (% style="color:#000000" %)Ответ:
1377 1377  
1378 -(% style="color:#000000" %){
1379 1379  
1380 - "vehicleId": "", ~/~/ID ТС 
1381 - "parentId": "", ~/~/Guid владельца ТС
1382 - "name": "", ~/~/Имя объекта
1383 - "imei": "", ~/~/IMEI
1384 - "deviceTypeId": "", ~/~/ID типа устройства
1385 - "modelId": "", ~/~/ID модели
1386 - "unitId": "", ~/~/ID подразделения
1387 - "sim1": "", ~/~/SIM1
1388 - "sim2": "", ~/~/SIM2
1389 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1390 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1391 - "counters": { ~/~/Счётчики
1392 - "mileageEnabled": true,
1393 - "motohoursEnabled": true,
1394 - "mileage": "",
1395 - "motohours": 345.0
1396 - },
1397 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1398 - "id": null,
1399 - "enabled": true, ~/~/флаг включения
1400 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1401 - "login": "", ~/~/ имя учетной записи
1402 - "password": "" ~/~/ пароль учетной записи
1403 - },
1404 - "inspectionTasks": { ~/~/ задания на ТО
1405 - "id": "", ~/~/ ID задачи
1406 - "enabled": false, ~/~/ Признак включения
1407 - "name": "", ~/~/ Имя задания
1408 - "description": "", ~/~/ Описание задания
1409 - "mileageCondition": "", ~/~/ Условие по пробегу
1410 - "lastMileage": "", ~/~/ Пробег (в метрах)
1411 - "motohoursCondition": "", ~/~/ Условие по моточасам
1412 - "lastMotohours": "", ~/~/ Моточасы
1413 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1414 - "kind": "", ~/~/ Вид периодичности по времени 
1415 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1419 +(((
1420 +(((
1421 +(((
1422 +{
1423 + "vehicleId": 0,  ~/~/ ID ТС
1424 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1425 + "name": "string", ~/~/ Имя объекта
1426 + "imei": "string", ~/~/ IMEI
1427 + "deviceTypeId": 0, ~/~/ ID типа устройства
1428 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1429 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1430 + "sim1": "string", ~/~/ SIM1
1431 + "sim2": "string", ~/~/ SIM2
1432 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1433 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1434 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1435 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1436 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1437 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1438 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1439 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1440 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1441 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1442 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1443 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1444 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1445 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1446 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1447 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1448 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1449 + "counters": {  ~/~/ Dto для состояний счётчиков
1450 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1451 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1452 + "mileage": 0, ~/~/ Пробег
1453 + "motohours": 0 ~/~/ Моточасы
1454 + },
1455 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1456 + "id": "string", ~/~/ CMSV6 Идентификатор
1457 + "enabled": true, ~/~/ Признак включения
1458 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1459 + "login": "string", ~/~/ CMSV6 имя учетной записи
1460 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1461 + },
1462 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1463 + {
1464 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1465 + "enabled": true, ~/~/ Признак включения
1466 + "name": "string", ~/~/ Имя задания
1467 + "description": "string", ~/~/ Описание задания
1468 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1469 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1470 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1471 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1472 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1473 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1474 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1475 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1416 1416   }
1477 + ],
1478 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1479 + {
1480 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1481 + "inputNumber": 0, ~/~/ № входа.
1482 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1483 + "comment": "string", ~/~/ Комментарий
1484 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1485 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1486 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1487 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1488 + }
1489 + ],
1490 + "commandTemplates": [  ~/~/ Список шаблонов команд
1491 + {
1492 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1493 + "name": "string", ~/~/ Название шаблона команд
1494 + "command": "string", ~/~/ Команда на выполнение
1495 + "retries": 0 ~/~/ Лимит попыток отправки
1496 + }
1497 + ],
1498 + "sensors": [ ~/~/ Список датчиков
1499 + {
1500 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1501 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1502 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1503 + "name": "string",  ~/~/ Имя датчика
1504 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1505 + "inputNumber": 0, ~/~/ Номер входа
1506 + "pseudonym": "string", ~/~/ Псевдоним
1507 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1508 + "isInverted": true, ~/~/  Признак инверсии
1509 + "disabled": true, ~/~/ Датчик не участвует в обработке
1510 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1511 + "gradesTables": [ ~/~/ Тарировка
1512 + {
1513 + "grades": [ ~/~/ Таблицы тарировки
1514 + {
1515 + "input": 0, ~/~/ Вход
1516 + "output": 0 ~/~/ Выход
1517 + }
1518 + ],
1519 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1520 + }
1521 + ],
1522 + "showInTooltip": true, ~/~/ Отображение в подсказке
1523 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1524 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1525 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1526 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1527 + "expr": "string", ~/~/ Выражение
1528 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1529 + "string"
1530 + ],
1531 + "customParams": {
1532 + "additionalProp1": "string",
1533 + "additionalProp2": "string",
1534 + "additionalProp3": "string"
1535 + },
1536 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1537 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1538 + {
1539 + "from": 0, ~/~/ С какого значения
1540 + "color": "string", ~/~/ Каким цветом
1541 +)))
1417 1417  
1418 -(% style="text-align:left" %)
1419 -(% style="color:#000000" %)}
1543 +(((
1544 + "text": "string" ~/~/ Текст подписи к этому интервалу
1545 + }
1546 + ]
1547 + }
1548 + ],
1549 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1550 + "customFields": [ ~/~/ Список произвольных полей
1551 + {
1552 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1553 + "name": "string", ~/~/ Наименование произвольного поля
1554 + "value": "string", ~/~/ Значение произвольного поля
1555 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1556 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1557 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1558 + }
1559 + ],
1560 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
1561 +}
1562 +)))
1563 +)))
1564 +)))
1420 1420  
1566 +
1421 1421  **Валидация:**
1422 1422  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1423 1423  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1424 1424  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1425 1425  
1426 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1427 1427  
1573 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1574 +
1575 +(% class="box successmessage" %)
1576 +(((
1577 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1578 +)))
1579 +
1580 +Метод запроса: **POST**
1581 +
1582 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1583 +
1584 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1585 +
1586 +
1587 +Ответ:
1588 +
1589 +{
1590 +
1591 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1592 +
1593 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1594 +
1595 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1596 +
1597 + "Message": "string", ~/~/ Информация о выполнении запроса
1598 +
1599 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1600 +
1601 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1602 +
1603 + "Data": "string" ~/~/ Данные
1604 +
1605 +}
1606 +
1607 +
1608 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1609 +
1428 1428  (% class="box infomessage" %)
1429 1429  (((
1612 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1613 +)))
1614 +
1615 +Метод запроса: **GET**
1616 +
1617 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1618 +
1619 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1620 +
1621 +
1622 +Ответ:
1623 +
1624 +{
1625 +
1626 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1627 +
1628 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1629 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1630 +
1631 + "Message": "string", ~/~/ Информация о выполнении запроса
1632 +
1633 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1634 +
1635 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1636 +
1637 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1638 +
1639 + "Data": "string" ~/~/ Данные
1640 +
1641 +}
1642 +
1643 +
1644 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1645 +
1646 +(% class="box infomessage" %)
1647 +(((
1430 1430  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1431 1431  )))
1432 1432  
1433 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1651 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1434 1434  
1435 1435  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1436 1436  
... ... @@ -1464,9 +1464,12 @@
1464 1464   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1465 1465   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1466 1466   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1467 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1468 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1469 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1685 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1686 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1687 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1688 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1689 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1690 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1470 1470  }
1471 1471  
1472 1472  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1473,8 +1473,14 @@
1473 1473  
1474 1474  (% style="color:#000000" %)Ответ:
1475 1475  
1476 -(% style="color:#000000" %){
1697 +(% style="color:#000000" %)[
1698 +{
1477 1477  
1700 +(((
1701 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1702 +)))
1703 +
1704 +(((
1478 1478  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1479 1479   "name": "" ~/~/ наименование объекта
1480 1480   "imei": "" ~/~/ IMEI объекта
... ... @@ -1500,9 +1500,21 @@
1500 1500   "forClient": true, ~/~/ право на отображение у клиента
1501 1501   "forTooltip": false, ~/~/ право на отображение в подсказке
1502 1502   "forReport": false ~/~/ право на отображение в отчетах
1503 - }(%%)
1504 -(% style="color:#000000" %)}
1730 +)))
1505 1505  
1732 +(((
1733 + }
1734 + ],
1735 + "vehicleGroups": [  ~/~/ Группы ТС
1736 + {
1737 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1738 + "name": "string" ~/~/ Наименование группы ТС
1739 + }
1740 + ]
1741 + }
1742 +]
1743 +)))
1744 +
1506 1506  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1507 1507  
1508 1508  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -1534,13 +1534,11 @@
1534 1534   "data": "", ~/~/ Данные
1535 1535   "overwrite": false, ~/~/ Флаг перезаписи
1536 1536   "stage": "", ~/~/ Состояние, может быть null
1537 -
1538 1538  (% style="color:#000000" %)}
1539 1539  
1540 1540  (% style="color:#000000" %)Ответ:
1541 1541  
1542 -(% style="color:#000000" %){
1543 -
1780 +(% style="color:#000000" %){(%%)
1544 1544   "status": "", ~/~/ значение статуса
1545 1545   "date": "", ~/~/ Дата смены статуса 
1546 1546   "description": "", ~/~/ Описание
... ... @@ -1547,10 +1547,10 @@
1547 1547   "data": "", ~/~/ Данные
1548 1548   "overwrite": false, ~/~/ Флаг перезаписи
1549 1549   "stage": "", ~/~/ Состояние
1550 -
1551 -(% style="text-align:left" %)
1552 1552  (% style="color:#000000" %) }
1553 1553  
1789 +== ==
1790 +
1554 1554  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1555 1555  
1556 1556  (% class="box warningmessage" %)
... ... @@ -1638,8 +1638,7 @@
1638 1638   "retries": 0
1639 1639   }
1640 1640   ],
1641 -
1642 - "sensors": [ ~/~/ Датчики
1878 +"sensors": [ ~/~/ Датчики
1643 1643   {
1644 1644   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1645 1645   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1677,95 +1677,215 @@
1677 1677   "additionalProp2": "string",
1678 1678   "additionalProp3": "string"
1679 1679   },
1680 -
1681 1681  ~/~/ Характерные для произвольного:
1682 -
1683 1683  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1684 -
1685 1685  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1686 -
1687 1687  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1688 -
1689 1689  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1690 -
1691 1691  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1692 -
1693 1693  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1694 -
1695 1695  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1696 -
1697 1697  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1698 -
1699 1699  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1700 -
1701 1701  ~/~/ "ValueOn": "Вкл.",
1702 -
1703 1703  ~/~/ "ValueOff": "Выкл."
1704 1704   "summaryMaxValue": 0 ~/~/ Макс. значение
1929 +
1930 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1931 + {
1932 + "from": 0, ~/~/ С какого значения
1933 + "color": "string", ~/~/ Каким цветом
1934 + "text": "string" ~/~/ Текст подписи к этому интервалу
1935 + }
1936 + ]
1705 1705   }
1706 1706   ],
1939 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1940 +
1707 1707   "customFields": [ ~/~/ Произвольные поля
1708 - {
1709 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1710 - "name": "string",
1711 - "value": "string",
1712 - "forClient": true,
1713 - "forTooltip": true,
1714 - "forReport": true
1942 + {     
1943 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1944 + "name": "string", ~/~/ Наименование произвольного поля
1945 + "value": "string", ~/~/ Значение произвольного поля
1946 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1947 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1948 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1715 1715   }
1716 1716   ]
1717 1717  }
1718 1718  
1953 +
1719 1719  (% style="color:#000000" %)Ответ:
1720 1720  
1721 -(% lang="en-US" style="text-align:left" %)
1722 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1956 +(((
1957 +{
1958 + "vehicleId": 0, ~/~/ ID ТС
1959 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1960 + "name": "string", ~/~/ Имя объекта
1961 + "imei": "string", ~/~/ IMEI
1962 + "deviceTypeId": 0, ~/~/ ID типа устройства
1963 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1964 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1965 + "sim1": "string", ~/~/ SIM1
1966 + "sim2": "string", ~/~/ SIM2
1967 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1968 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1969 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1970 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1971 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1972 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1973 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1974 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1975 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1976 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1977 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1978 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1979 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1980 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1981 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1982 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1983 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1984 + "counters": { ~/~/ состояний счётчиков
1985 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1986 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1987 + "mileage": 0, ~/~/ Пробег
1988 + "motohours": 0 ~/~/ Моточасы 
1989 + },
1990 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1991 + "id": "string", ~/~/ CMSV6 Идентификатор
1992 + "enabled": true, ~/~/ Признак включения
1993 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1994 +)))
1723 1723  
1724 -(% lang="en-US" style="text-align:left" %)
1725 - "vehicleId": "", ~/~/ ID ТС
1726 - "parentId": "", ~/~/ ID клиента
1727 - "name": "", ~/~/ имя ТС
1728 - "imei": "", ~/~/ IMEI
1729 - "deviceTypeId": "", ~/~/ типа устройства
1730 - "modelId": "", ~/~/ ID модели
1731 - "unitId": "", ~/~/ ID подразделения
1732 - "sim1": "", ~/~/ SIM 1
1733 - "sim2": "", ~/~/ SIM2
1734 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1735 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1736 - "counters": 
1737 - {
1738 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1739 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1740 - "mileage": "", ~/~/ пробег
1741 - "motohours": "", ~/~/ моточасы
1742 - }
1743 - "cmsv6Parameters": ~/~/ параметры CMSv6
1996 +
1997 +(((
1998 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1999 + "login": "string", ~/~/ CMSV6 имя учетной записи
2000 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
2001 + },
2002 + "inspectionTasks": [ ~/~/ Задания на ТО
2003 + {
2004 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2005 + "enabled": true, ~/~/ Признак включения
2006 + "name": "string", ~/~/ Имя задания
2007 + "description": "string", ~/~/ Описание задания
2008 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2009 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2010 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2011 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2012 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2013 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2014 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2015 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2016 + }
2017 + ],
2018 + "drivers": [  ~/~/ Список водителей
2019 + {
2020 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2021 + "inputNumber": 0, ~/~/ № входа.
2022 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2023 + "comment": "string", ~/~/ Комментарий.
2024 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2025 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2026 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2027 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2028 + }
2029 + ],
2030 + "commandTemplates": [ ~/~/ Список шаблонов команд
2031 + {
2032 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2033 + "name": "string", ~/~/ Название шаблона команд
2034 + "command": "string", ~/~/ Команда на выполнение
2035 + "retries": 0 ~/~/ Лимит попыток отправки
2036 + }
2037 + ],
2038 + "sensors": [  ~/~/ Список датчиков 
2039 + {
2040 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2041 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2042 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2043 +)))
2044 +
2045 +(((
2046 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2047 +)))
2048 +
2049 +(((
2050 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2051 +)))
2052 +
2053 +(((
2054 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2055 +)))
2056 +
2057 +(((
2058 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2059 +)))
2060 +
2061 +(((
2062 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2063 + "name": "string", ~/~/ Имя датчика
2064 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2065 +)))
2066 +
2067 +(((
2068 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2069 + "inputNumber": 0, ~/~/ Номер входа
2070 + "pseudonym": "string", ~/~/ Псевдоним
2071 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2072 + "isInverted": true, ~/~/ Признак инверсии
2073 + "disabled": true, ~/~/ Датчик не участвует в обработке
2074 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2075 + "gradesTables": [ ~/~/ Тарировка
1744 1744   {
1745 - "id": ~/~/ идентификатор
1746 - "enabled": true, ~/~/ флаг включения
1747 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1748 - "login": "", ~/~/ имя учетной записи
1749 - "password": "", ~/~/ пароль учетной записи
1750 - }
1751 - "inspectionTasks": ~/~/ задания на ТО
2077 + "grades": [ ~/~/ Таблицы тарировки
2078 + {
2079 + "input": 0, ~/~/ Вход
2080 + "output": 0 ~/~/ Выход
2081 + }
2082 + ],
2083 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2084 + }
2085 + ],
2086 + "showInTooltip": true, ~/~/ Отображение в подсказке
2087 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
2088 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2089 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2090 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2091 + "expr": "string", ~/~/ Выражение
2092 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2093 + "string" 
2094 + ],
2095 + "customParams": { ~/~/ Дополнительные настройки
2096 + "additionalProp1": "string",
2097 + "additionalProp2": "string",
2098 + "additionalProp3": "string"
2099 + },
2100 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2101 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1752 1752   {
1753 - "id": "", ~/~/ ID задания
1754 - "enabled": false, ~/~/ Признак включения
1755 - "name": "", ~/~/ Имя задания
1756 - "description": "", ~/~/ Описание задания
1757 - "mileageCondition": "", ~/~/ Условие по пробегу
1758 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1759 - "motohoursCondition": "", ~/~/ Условие по моточасам
1760 - "lastMotohours": "", ~/~/ Моточасы
1761 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1762 - "kind": "", ~/~/ Вид периодичности по времени
1763 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2103 + "from": 0, ~/~/ С какого значения
2104 + "color": "string", ~/~/ Каким цветом
2105 + "text": "string" ~/~/ Текст подписи к этому интервалу
1764 1764   }
2107 + ]
2108 + }
2109 + ],
2110 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2111 + "customFields": [ ~/~/ Список произвольных полей
2112 + {
2113 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2114 + "name": "string", ~/~/ Наименование произвольного поля
2115 + "value": "string", ~/~/ Значение произвольного поля
2116 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2117 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2118 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2119 + }
2120 + ],
2121 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2122 +}
2123 +)))
1765 1765  
1766 -(% lang="en-US" style="text-align:left" %)
1767 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1768 -
1769 1769  **Валидация:**
1770 1770  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1771 1771  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -1804,18 +1804,15 @@
1804 1804  
1805 1805  (% style="color:#000000" %)Метод запроса: **GET**
1806 1806  
1807 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
2163 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1808 1808  
1809 1809  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1810 1810  
1811 1811  (% style="color:#000000" %)Ответ:
1812 1812  
1813 -(% style="color:#000000" %){
1814 -
2169 +(% style="color:#000000" %){(%%)
1815 1815   "deviceTypeId" : "", ~/~/ ID типа устройства
1816 1816   "deviceTypeName" : "" ~/~/ Название типа устройства
1817 -
1818 -(% style="text-align:left" %)
1819 1819  (% style="color:#000000" %)}
1820 1820  
1821 1821  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1837,13 +1837,10 @@
1837 1837  
1838 1838  (% style="color:#000000" %)Ответ:
1839 1839  
1840 -(% style="color:#000000" %){
1841 -
2193 +(% style="color:#000000" %){(%%)
1842 1842   "id": "", ~/~/ ID типа датчика 
1843 1843   "name": "", ~/~/ Название
1844 1844   "description": "", ~/~/ Описание
1845 -
1846 -(% style="text-align:left" %)
1847 1847  (% style="color:#000000" %)}
1848 1848  
1849 1849  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1930,8 +1930,13 @@
1930 1930  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1931 1931  |protocolType|Тип протокола
1932 1932  |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1933 -|inputNumber|Номер входа
2283 +|inputNumber|(((
2284 +Номер входа
2285 +)))
1934 1934  
2287 +(% class="wikigeneratedid" %)
2288 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2289 +
1935 1935  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1936 1936  
1937 1937  (% class="box infomessage" %)
... ... @@ -2040,10 +2040,12 @@
2040 2040   {
2041 2041   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2042 2042   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2043 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2044 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2045 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2046 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2398 + "mileage": 0, ~/~/ Пробег за период, километры
2399 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2400 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2401 + "motohours": 0, ~/~/ Моточасы за период, секунды
2402 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2403 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2047 2047   }
2048 2048   ]
2049 2049   }
... ... @@ -2092,6 +2092,12 @@
2092 2092   }
2093 2093  ]
2094 2094  
2452 +(% class="box warningmessage" %)
2453 +(((
2454 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2455 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2456 +)))
2457 +
2095 2095  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2096 2096  
2097 2097  (% class="box infomessage" %)
... ... @@ -2137,6 +2137,96 @@
2137 2137   }
2138 2138  ]
2139 2139  
2503 +
2504 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2505 +
2506 +(% class="box infomessage" %)
2507 +(((
2508 +**POST /api/v3/vehicles/moveStop**
2509 +)))
2510 +
2511 +Метод запроса: **POST**
2512 +
2513 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2514 +
2515 +В заголовках запроса: X-Auth: Токен авторизации
2516 +
2517 +
2518 +Тело запроса:
2519 +
2520 +{
2521 + "vehicleIds": [ ], ~/~/ Список ID объектов
2522 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2523 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2524 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2525 +}
2526 +
2527 +Ответ:
2528 +
2529 +[ 
2530 + {
2531 + "vehicleId": 0, ~/~/ ID объекта
2532 + "vehicleName": "string", ~/~/ Имя объекта
2533 + "moves": [ ~/~/ Событие движения
2534 + {
2535 + "mileage": 0, ~/~/ Пробег, км
2536 + "eventId": 0, ~/~/ Идентификатор события
2537 + "eventName": "string", ~/~/ Название события
2538 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2539 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2540 + "duration": 0 ~/~/ Продолжительность события, секунд
2541 + }
2542 + ],
2543 + "stops": [ ~/~/ События стоянок
2544 + {
2545 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2546 + "eventId": 0, ~/~/ Идентификатор события
2547 + "eventName": "string", ~/~/ Название события
2548 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2549 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2550 + "duration": 0 ~/~/ Продолжительность события, секунд
2551 + }
2552 + ]
2553 + }
2554 +]
2555 +
2556 +
2557 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2558 +
2559 +(% class="box infomessage" %)
2560 +(((
2561 +**POST /api/v3/vehicles/getlastdata**
2562 +)))
2563 +
2564 +Метод запроса: **POST**
2565 +
2566 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2567 +
2568 +В заголовках запроса: X-Auth: Токен авторизации
2569 +
2570 +
2571 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2572 +
2573 +Ответ:
2574 + {
2575 + "vehicleId": 0, ~/~/Идентификатор объекта.
2576 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2577 + "vehicleNumber": "string",~/~/Номер объекта.
2578 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2579 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2580 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2581 + "speed": 0,~/~/Скорость объекта.
2582 + "course": 0,~/~/Курс движения [0;360]
2583 + "latitude": 0,~/~/Широта [-90°;90°].
2584 + "longitude": 0,~/~/Долгота [-180°;180°].
2585 + "address": "string",~/~/Адрес.
2586 + "geozones": [ ~/~/Сведения по геозонам.
2587 + {
2588 + "id": 0,
2589 + "name": "string"
2590 + }
2591 +
2592 +
2140 2140  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2141 2141  
2142 2142  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2444,6 +2444,32 @@
2444 2444  
2445 2445  Success
2446 2446  
2900 +
2901 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2902 +
2903 +(% class="box warningmessage" %)
2904 +(((
2905 +**PUT** /api/v3/notifications/prolongation
2906 +)))
2907 +
2908 +Метод позволяет продлить уведомления.
2909 +
2910 +Метод запроса **PUT**
2911 +
2912 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2913 +
2914 +В заголовках запроса: X-Auth: Токен авторизации.
2915 +
2916 +Тело запроса:
2917 +
2918 +[
2919 +
2920 +0
2921 +
2922 +]
2923 +
2924 +где 0 идентификатор ids.
2925 +
2447 2447  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2448 2448  
2449 2449  (% class="box errormessage" %)
... ... @@ -3634,7 +3634,7 @@
3634 3634  **POST /api/v3/vehicles/import/{agentId}**
3635 3635  )))
3636 3636  
3637 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
4116 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3638 3638  
3639 3639  В пути указывается **agentId** - id клиента.
3640 3640  
... ... @@ -3646,7 +3646,7 @@
3646 3646  
3647 3647  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3648 3648  |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3649 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
4128 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3650 3650  
3651 3651  В теле использовать тип **form-data,** тип значения** file**
3652 3652  
... ... @@ -3813,7 +3813,7 @@
3813 3813  
3814 3814  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3815 3815  
3816 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
4295 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3817 3817  
3818 3818  (% class="box infomessage" %)
3819 3819  (((
... ... @@ -3825,64 +3825,67 @@
3825 3825  Тело запроса:
3826 3826  
3827 3827  {
3828 - "vehicleIds": [vehicleId],
3829 - "from": "2023-11-22T09:29:48.051Z",
3830 - "to": "2023-11-22T09:29:48.051Z"
4307 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4308 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4309 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
3831 3831  }
3832 3832  
3833 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3834 -|vehicleIds|Массив ID объектов
3835 -|from|Дата начала запроса
3836 -|to|Дата окончания запроса
3837 -
3838 3838  Ответ:
3839 3839  
3840 3840  {
3841 - "items": [
4315 + "items": [  ~/~/ Список в разрезе ТС
3842 3842   {
3843 - "from": "2023-11-22T09:29:48.052Z",
3844 - "to": "2023-11-22T09:29:48.052Z",
3845 - "vehicleId": 0,
3846 - "vehicleName": "string",
3847 - "vehicleModel": "string",
3848 - "penalty": 0,
3849 - "score": 0,
3850 - "totalViolations": 0,
3851 - "violationsByType": {
3852 - "overspeedingViolations": 0,
3853 - "accelerationViolations": 0,
3854 - "brakingViolations": 0,
3855 - "turningViolations": 0,
3856 - "dangerousDrivingViolations": 0,
3857 - "sensorViolations": 0
4317 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4318 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4319 + "vehicleId": 0, ~/~/ ID ТС
4320 + "vehicleName": "string", ~/~/ Название ТС
4321 + "vehicleModel": "string", ~/~/ Модель ТС
4322 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4323 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4324 + "totalViolations": 0, ~/~/ Нарушений всего
4325 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4326 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4327 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4328 + "brakingViolations": 0, ~/~/ Нарушений торможения
4329 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4330 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4331 + "sensorViolations": 0 ~/~/ Нарушений по датчику
3858 3858   },
3859 - "moveTime": 0,
3860 - "mileage": 0,
3861 - "tripsCount": 0,
3862 - "trips": [
4333 +
4334 +(((
4335 +
4336 +)))
4337 +
4338 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4339 + "mileage": 0, ~/~/ Пробег, м
4340 + "tripsCount": 0, ~/~/ Кол-во рейсов
4341 + "trips": [  ~/~/ Информация по рейсу
3863 3863   {
3864 - "penalty": 0,
3865 - "score": 0,
3866 - "violationsCount": 0,
3867 - "violationsByType": {
3868 - "overspeedingViolations": 0,
3869 - "accelerationViolations": 0,
3870 - "brakingViolations": 0,
3871 - "turningViolations": 0,
3872 - "dangerousDrivingViolations": 0,
3873 - "sensorViolations": 0
4343 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4344 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4345 + "violationsCount": 0, ~/~/ Всего нарушений
4346 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4347 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4348 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4349 + "brakingViolations": 0, ~/~/ Нарушений торможения
4350 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4351 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4352 + "sensorViolations": 0 ~/~/ Нарушений по датчику
3874 3874   },
3875 - "moveTime": 0,
3876 - "mileage": 0,
3877 - "motohours": 0,
3878 - "maxSpeed": 0,
3879 - "startAddress": "string",
3880 - "endAddress": "string",
3881 - "drivers": [
4354 +
4355 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4356 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4357 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4358 + "mileage": 0, ~/~/ Пробег, м
4359 + "motohours": 0, ~/~/ Моточасы, секунды
4360 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4361 + "startAddress": "string", ~/~/ Адрес начала рейса
4362 + "endAddress": "string", ~/~/ Адрес конца рейса
4363 + "drivers": [  ~/~/ Список водителей
3882 3882   {
3883 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3884 - "driverName": "string",
3885 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4365 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4366 + "driverName": "string", ~/~/ФИО водителя
4367 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
3886 3886   }
3887 3887   ]
3888 3888   }
... ... @@ -3891,34 +3891,444 @@
3891 3891   ]
3892 3892  }
3893 3893  
3894 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3895 -|from|Дата начала запроса
3896 -|to|Дата  окончания
3897 -|vehicleId|ID объекта
3898 -|vehicleName|Имя объекта
3899 -|vehicleModel|Модель объекта
3900 -|penalty|Сумма штрафных баллов
3901 -|score|Оценка
3902 -|totalViolations|Суммарное количество нарушений
3903 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3904 -|overspeedingViolations|Превышение скорости
3905 -|accelerationViolations|Ускорение
3906 -|brakingViolations|Торможение
3907 -|turningViolations|Резкий поворот
3908 -|dangerousDrivingViolations|Резкое вождение
3909 -|sensorViolations|Нарушение по датчику
3910 -|moveTime|Время в движении
3911 -|mileage|Пробег
3912 -|tripsCount|Количество рейсов
3913 -|motohours|Моточасы
3914 -|maxSpeed|Максимальная скорость
3915 -|startAddress|Адрес начала рейса
3916 -|endAddress|Адрес окончания рейса
3917 -|drivers|Список водителей, которые были на объекте в течениии рейса
3918 -|driverGuid|Guid водителя
3919 -|driverName|Имя водителя
3920 -|driverRfid|Номер Карты-метки
4376 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3921 3921  
4378 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4379 +
4380 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4381 +
4382 +(% class="box infomessage" %)
4383 +(((
4384 +POST /api/v3/fuelcards/transactions
4385 +)))
4386 +
4387 +Метод запроса: POST
4388 +
4389 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4390 +\\В заголовках запроса: X-Auth: Токен авторизации
4391 +
4392 +Параметры в теле запроса (JSON):
4393 +
4394 +{
4395 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4396 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4397 + "ids": [ 
4398 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4399 + ],
4400 + "timezone": 0 ~/~/Таймзона
4401 +}
4402 +
4403 +
4404 +Ответ:
4405 + {
4406 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4407 + "driver": "string", ~/~/Водители, привязанные к ТК
4408 + "object": "string", ~/~/Наименование ТС
4409 + "amount": 0, ~/~/Количество топлива
4410 + "amountDut": 0, ~/~/Количество по ДУТ
4411 + "amountDiff": 0, ~/~/Разница, л
4412 + "amountDiffPerc": 0, ~/~/Разница, %
4413 + "summa": 0, ~/~/Стоимость, руб
4414 + "serviceName": "string", ~/~/Тип топлива
4415 + "price": 0, ~/~/Цена за литр, руб
4416 + "cardName": "string", ~/~/Наименование ТК
4417 + "cardNum": "string", ~/~/Номер ТК
4418 + "operator": "string", ~/~/Оператор ТК
4419 + "address": "string" ~/~/Адрес АЗС
4420 + }
4421 +
4422 +
4423 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4424 +
4425 +
4426 +== **Получение полных данных о ретрансляторе** ==
4427 +
4428 +(% class="box infomessage" %)
4429 +(((
4430 +**GET ** **/api/v3/retranslations/{id}**
4431 +)))
4432 +
4433 +Идентификатор запроса: ID
4434 +
4435 +
4436 +Пример ответа:
4437 +
4438 +{  
4439 +"description": "", ~/~/ Определяет описание
4440 +"subscriberId": "", ~/~/ Подписчик
4441 +"protocolType": 0, ~/~/ Тип протокола
4442 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4443 +"address": "string", ~/~/ Адрес события
4444 +"objects": [ ~/~/Объекты для ретрансляции
4445 +{      
4446 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4447 +"name": "", ~/~/ Наименование объекта ретрансляции
4448 +"imei": "", ~/~/ IMEI объекта  
4449 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4450 +}
4451 + ],  
4452 +"id": "", ~/~/ идентификатор пользователя   
4453 +"parentId": "", ~/~/Guid родителя
4454 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4455 +}
4456 +
4457 +
4458 +== **Удаление данных ретранслятора** ==
4459 +
4460 +(% class="box infomessage" %)
4461 +(((
4462 +**DELETE** **/api/v3/retranslations/{id}**
4463 +)))
4464 +
4465 +Параметр запроса: ID
4466 +
4467 +
4468 +== **Создание ретранслятора** ==
4469 +
4470 +(% class="box infomessage" %)
4471 +(((
4472 +**POST ** **/api/v3/retranslations/{id}**
4473 +)))
4474 +
4475 +Запрос:
4476 +
4477 +{  
4478 +"description": "", ~/~/ Описание
4479 +"subscriberId": "", ~/~/ Подписчик
4480 +"protocolType": 0, ~/~/ Тип протокола
4481 +"address": "", ~/~/ Адрес ретрансляции
4482 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4483 +"objects": [ ~/~/Объекты для ретрансляции
4484 +{      
4485 +"id": "", ~/~/ идентификатор пользователя     
4486 +"imei": "", ~/~/IMEI объекта
4487 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4488 +}
4489 + ]
4490 +}
4491 +
4492 +
4493 +Ответ:
4494 +
4495 +{  
4496 +"description": "string", ~/~/ Определяет описание
4497 +"subscriberId": "", ~/~/ идентификатор запроса
4498 +"protocolType": 0, ~/~/ Тип протокола
4499 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4500 +"address": "", ~/~/ Адрес события
4501 +"objects": [ ~/~/Объекты для ретрансляции
4502 +{      
4503 +"id": "", ~/~/ идентификатор пользователя    
4504 +"name": "string", ~/~/ Название уведомления
4505 +"imei": "string", ~/~/IMEI объекта  
4506 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4507 +}
4508 + ],  
4509 +"id": "", ~/~/ идентификатор пользователя  
4510 +"parentId": "", ~/~/ Guid идентификатор родителя
4511 +"deleted": true ~/~/ Признак удаления
4512 +}
4513 +
4514 +
4515 +== **Редактирование ретранслятора** ==
4516 +
4517 +(% class="box infomessage" %)
4518 +(((
4519 +**PUT** **/api/v3/retranslations**
4520 +)))
4521 +
4522 +Пример запроса:
4523 +
4524 +{  
4525 +"id": "", ~/~/ идентификатор пользователя   
4526 +"description": "string", ~/~/ Определяет описание
4527 +"subscriberId": "", ~/~/ идентификатор запроса
4528 +"protocolType": 0, ~/~/ Тип протокола
4529 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4530 +"address": "string", ~/~/ Адрес события
4531 +"objects": ~/~/Объекты для ретрансляции
4532 +[    
4533 +{      
4534 +"id": "",  ~/~/ идентификатор пользователя         
4535 +"imei": "", ~/~/IMEI объекта
4536 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4537 +}
4538 + ]
4539 +}
4540 +
4541 +
4542 +Пример ответа:
4543 +
4544 +{  
4545 +"description": "", ~/~/ Определяет описание
4546 +"subscriberId": "", ~/~/ идентификатор запроса
4547 +"protocolType": 0, ~/~/ Тип протокола
4548 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4549 +"address": "string", ~/~/ Адрес события
4550 +"objects": [ ~/~/Объекты для ретрансляции
4551 +{      
4552 +"id": "", ~/~/ идентификатор пользователя     
4553 +"name": "string", ~/~/ Название уведомления    
4554 +"imei": "", ~/~/IMEI объекта
4555 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4556 +}
4557 + ],
4558 +"id": "", ~/~/ идентификатор пользователя   
4559 +"parentId": "", ~/~/ Guid идентификатор родителя
4560 +"deleted": true ~/~/ Признак удаления
4561 +}
4562 +
4563 +
4564 +== **Получение списка ретранслятора клиента** ==
4565 +
4566 +(% class="box infomessage" %)
4567 +(((
4568 +**POST /api/v3/retranslations/find**
4569 +)))
4570 +
4571 +Пример запроса:
4572 +
4573 +{  
4574 +"id": "", ~/~/ идентификатор пользователя   
4575 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4576 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4577 +}
4578 +
4579 +Ответ:
4580 +
4581 +[ 
4582 +{    
4583 +"description": "", ~/~/ Определяет описание
4584 +"subscriberId": "", ~/~/ идентификатор запроса
4585 +"protocolType": 0, ~/~/ Тип протокола
4586 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4587 +"address": "string", ~/~/ Адрес события
4588 +"id": "", ~/~/ идентификатор пользователя   
4589 +"parentId": "", ~/~/ Guid идентификатор родителя
4590 +"deleted": true ~/~/ Признак удаления
4591 +}
4592 +]
4593 +
4594 +
4595 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4596 +
4597 +== **API для отчета по выгрузке комбайнов** ==
4598 +
4599 +(% class="box infomessage" %)
4600 +(((
4601 +POST **/api/v3/Reports/harvesterUnloading**
4602 +)))
4603 +
4604 +Пример запроса:
4605 +
4606 +{
4607 + "byTime": 0, ~/~/ Объединение событий по времени
4608 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4609 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4610 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4611 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4612 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4613 + 0
4614 + ],
4615 + "from": "", ~/~/ Дата и время начало запроса
4616 + "to": "", ~/~/ Дата и время окончания запроса
4617 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4618 +}
4619 +
4620 +Пример ответа:
4621 +
4622 +[ 
4623 + {
4624 + "harvesterName": "", ~/~/Комбайн, номер
4625 + "harvesterId": 0, ~/~/Комбайн, id
4626 +"harvesterModel": "", ~/~/ Модель комбайна
4627 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4628 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4629 + "events": [ ~/~/Список событий в разрезе комбайна
4630 + {
4631 + "driverId": "", ~/~/Идентификатор водителя
4632 + "driverName": "", ~/~/Водитель комбайна, ФИО
4633 + "RFID": "", ~/~/ идентификатор карты-метки
4634 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4635 + "vehicleId": 0, ~/~/идентификатор объекта
4636 + "vehicleName": "string", ~/~/ Имя объекта
4637 + "modelName": "string", ~/~/ Имя модели объекта
4638 + "nearestVehicles": [ ~/~/Объекты рядом
4639 + {
4640 + "vehicleId": 0, ~/~/идентификатор объекта
4641 + "vehicleName": "string" ~/~/ Имя объекта
4642 + }
4643 + ],
4644 + "fields": [ ~/~/Поля, где происходила выгрузка
4645 + {
4646 + "id": 0, ~/~/ идентификатор пользователя 
4647 + "name": "string" ~/~/ имя пользователя 
4648 + }
4649 + ],
4650 + "event": "string", ~/~/Событие
4651 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4652 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4653 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4654 + "cultureName": "string", ~/~/ название культуры
4655 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4656 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4657 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4658 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4659 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4660 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4661 + "issued": 0, ~/~/Выдано, бункеров
4662 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4663 + "latitude": 0, ~/~/Широта
4664 + "longitude": 0, ~/~/ Долгота
4665 + "litresAway": 0, ~/~/Отдано, л
4666 + "m3Away": 0 ~/~/Отдано, м3
4667 + }
4668 + ]
4669 + }
4670 +]
4671 +
4672 +
4673 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4674 +
4675 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4676 +
4677 +
4678 +(% class="box infomessage" %)
4679 +(((
4680 +GET api/v3/Vehicles/recyclebin/all
4681 +)))
4682 +
4683 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4684 +
4685 +Параметр запроса: {parentId} - идентификатор агента
4686 +
4687 +В заголовках запроса: X-Auth: Токен авторизации
4688 +
4689 +Ответ:
4690 +
4691 +[ 
4692 + {
4693 + "recordTime": "", ~/~/Время записи
4694 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4695 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4696 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4697 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4698 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4699 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4700 + "items": [ ~/~/ 
4701 +nullable: true ~/~/Детали
4702 + {
4703 + "name": "string", ~/~/наименование столбца
4704 + "value": "string" ~/~/содержание столбца
4705 + }
4706 + ]
4707 + },
4708 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4709 + "string"
4710 + ]
4711 + }
4712 +]
4713 +
4714 +
4715 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4716 +
4717 +(% class="box infomessage" %)
4718 +(((
4719 +POST/api/v3/Vehicles/recyclebin/erase
4720 +)))
4721 +
4722 +В заголовках запроса: X-Auth: Токен авторизации
4723 +
4724 +Пример запроса:
4725 +
4726 +[
4727 +0
4728 +]
4729 +
4730 +
4731 +Пример ответа:
4732 +
4733 +[ 
4734 +{
4735 + "recordTime": "", ~/~/Время записи
4736 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4737 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4738 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4739 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4740 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4741 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4742 + "items": [ ~/~/Детали
4743 + {
4744 + "name": "", ~/~/Имя свойства
4745 + "value": "" ~/~/Значение свойства
4746 + }
4747 + ]
4748 + },
4749 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4750 + ""
4751 + ]
4752 + }
4753 +]
4754 +
4755 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4756 +
4757 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4758 +
4759 +(% class="box infomessage" %)
4760 +(((
4761 +POST/api/v3/Vehicles/recyclebin/restore
4762 +)))
4763 +
4764 +В заголовках запроса: X-Auth: Токен авторизации
4765 +
4766 +Параметры в теле запроса (JSON):
4767 +
4768 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4769 +
4770 +В заголовках запроса: X-Auth: Токен авторизации
4771 +
4772 +
4773 +Пример запроса:
4774 +
4775 +(((
4776 +[
4777 +)))
4778 +
4779 +(((
4780 + 0
4781 +)))
4782 +
4783 +(((
4784 +]
4785 +)))
4786 +
4787 +
4788 +Пример ответа:
4789 +
4790 +[
4791 +{
4792 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4793 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4794 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4795 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4796 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4797 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4798 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4799 + "items": [ ~/~/Детали
4800 + {
4801 + "name": "string", ~/~/Имя свойства
4802 + "value": "string" ~/~/Значение свойства
4803 + }
4804 + ]
4805 + },
4806 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4807 + "string"
4808 + ]
4809 + }
4810 +]
4811 +
4812 +
4813 +
3922 3922  (% class="box" lang="en-US" style="text-align: center;" %)
3923 3923  (((
3924 3924  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

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