Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 148.1 >
edited by Андрей Калиновский
on 2024/03/18 11:12
To version < 192.1 >
edited by Михаил Жучков
on 2024/12/16 18:00
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.SupportZhuchkov
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 оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
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" %)
... ... @@ -226,7 +226,6 @@
226 226   "bankKS": "string" ~/~/ корр. счёт
227 227  }
228 228  
229 -
230 230  Ответ:
231 231  
232 232  {
... ... @@ -420,7 +420,6 @@
420 420   ],
421 421   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
422 422  }
423 -
424 424  {
425 425   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
426 426   "lastName": "string",
... ... @@ -434,12 +434,8 @@
434 434  
435 435  (% style="text-align:left" %)
436 436  (% style="color:#000000; font-weight:normal" %)Ответ:
437 -
438 -(% style="text-align:left" %)
439 -(% style="color:#000000; font-weight:normal" %){    
440 -
441 -(% style="text-align:left" %)
442 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
455 +{     
456 + "id": "" , ~/~/ ID пользователя
443 443   "lastName": "" , ~/~/ Фамилия ,
444 444   "firstName": "" , ~/~/ Имя
445 445   "position": "" , ~/~/ Должность
... ... @@ -456,11 +456,9 @@
456 456   "kind": "" , ~/~/ тип аутентификации
457 457   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
458 458   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
473 +}
459 459  
460 -(% style="text-align:left" %)
461 -(% style="color:#000000; font-weight:normal" %)}
462 462  
463 -
464 464  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465 465  
466 466  (% class="box infomessage" %)
... ... @@ -480,19 +480,16 @@
480 480  
481 481  (% style="color:#000000" %)Параметры в теле запроса (JSON):
482 482  
483 -(% style="color:#000000" %){
484 -
495 +(% style="color:#000000" %){(%%)
485 485   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
486 486   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
487 487   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
488 488   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
489 -
490 490  (% style="color:#000000" %)}
491 491  
492 492  (% style="color:#000000" %)Ответ:
493 493  
494 494  (% style="color:#000000" %){         (%%)
495 -
496 496   "id": "" , ~/~/ идентификатор пользователя
497 497   "lastName": "" , ~/~/ фамилия
498 498   "firstName": "" , ~/~/ имя
... ... @@ -506,7 +506,6 @@
506 506   "sessionDuration":"", ~/~/ длительность сессии в минутах
507 507   "status": "1",  ~/~/ статус пользователя
508 508   "lastLogged": "", ~/~/ дата/время последней авторизации
509 -
510 510  (% style="color:#000000" %)}
511 511  
512 512  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -580,10 +580,8 @@
580 580  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
581 581  
582 582  (% lang="en-US" style="text-align:left" %)
583 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
584 -
585 -(% lang="en-US" style="text-align:left" %)
586 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
591 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
592 + "id": "" , ~/~/ ID пользователя 
587 587   "lastName": "" , ~/~/ фамилия
588 588   "firstName": "" , ~/~/ имя
589 589   "position": "" , ~/~/ должность
... ... @@ -605,9 +605,7 @@
605 605   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
606 606   },
607 607   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
608 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
609 -
610 -(% lang="en-US" style="text-align:left" %)
614 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
611 611  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
612 612  
613 613  (% lang="en-US" style="text-align:left" %)
... ... @@ -614,10 +614,8 @@
614 614  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
615 615  
616 616  (% lang="en-US" style="text-align:left" %)
617 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
618 -
619 -(% lang="en-US" style="text-align:left" %)
620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
621 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
622 + "id": "" , ~/~/ идентификатор пользователя
621 621   "lastName": "" , ~/~/ фамилия
622 622   "firstName": "" , ~/~/ имя
623 623   "position": "" , ~/~/ должность
... ... @@ -638,10 +638,8 @@
638 638   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
639 639   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
640 640   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
643 +}
641 641  
642 -(% lang="en-US" style="text-align:left" %)
643 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
644 -
645 645  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
646 646  
647 647  (% class="box warningmessage" %)
... ... @@ -661,12 +661,10 @@
661 661  
662 662  (% style="color:#000000" %)Параметры в теле запроса (JSON):
663 663  
664 -(% style="color:#000000" %){
665 -
664 +(% style="color:#000000" %){(%%)
666 666   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
667 667   "description": "" , ~/~/ описание
668 668   "data": "" , ~/~/ данные, связанные со сменой статуса
669 -
670 670  (% style="color:#000000" %)}
671 671  
672 672  (% style="text-align:left" %)
... ... @@ -688,7 +688,7 @@
688 688  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
689 689  
690 690   [ 
691 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
689 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
692 692   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
693 693   ]
694 694  
... ... @@ -994,7 +994,7 @@
994 994  
995 995  Ответ: В случае успеха **Success 200**
996 996  
997 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
998 998  
999 999  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1000 1000  
... ... @@ -1030,19 +1030,15 @@
1030 1030   "deviceTypeName": "", ~/~/ Название типа устройства
1031 1031   "sim1": "", ~/~/ Номер SIM1
1032 1032   "sim2": "", ~/~/ Номер SIM2
1033 -
1034 1034   "parentId": "", ~/~/ ID клиента-родителя
1035 1035   "parentName": "", ~/~/ Наименование клиента-родителя
1036 1036   "modelId": "", ~/~/ ID модели объекта
1037 1037   "modelName": "", ~/~/ Имя модели объекта
1038 -
1039 1039   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1040 1040   "unitName": "string", ~/~/ Наименование подразделения
1041 1041   "status": 0, ~/~/ Статус объекта
1042 -
1043 1043   "createdAt": "", ~/~/ Дата создания объекта
1044 1044   },
1045 -
1046 1046  "customFields": [ ~/~/ Произвольные поля
1047 1047   {
1048 1048   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -1065,8 +1065,7 @@
1065 1065   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1066 1066   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1067 1067   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1068 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
1069 -
1062 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1070 1070   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1071 1071   "mileageCoeff": 0, ~/~/ коэффициент пробега
1072 1072   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -1096,7 +1096,6 @@
1096 1096   "retries": 0 ~/~/ Количество попыток
1097 1097   }
1098 1098   ],
1099 -
1100 1100   "sensors": [ ~/~/ Датчики
1101 1101   {
1102 1102   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -1137,31 +1137,19 @@
1137 1137   },
1138 1138  
1139 1139  ~/~/ Характерные для произвольного:
1140 -
1141 1141  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1142 -
1143 1143  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1144 -
1145 1145  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1146 -
1147 1147  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 -
1149 1149  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1150 -
1151 1151  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1152 -
1153 1153  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1154 -
1155 1155  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1156 -
1157 1157  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1158 -
1159 1159  ~/~/ "ValueOn": "Вкл.",
1160 -
1161 1161  ~/~/ "ValueOff": "Выкл."
1162 1162   "summaryMaxValue": 0 ~/~/ Макс. значение
1163 1163   }
1164 -
1165 1165   "drivers": [ ~/~/ Водители
1166 1166   {
1167 1167   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1170,7 +1170,6 @@
1170 1170   "isDefault": true ~/~/ По умолчанию
1171 1171   }
1172 1172   ],
1173 -
1174 1174   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1175 1175   {
1176 1176   "id": "", ~/~/ ID  задания
... ... @@ -1187,8 +1187,7 @@
1187 1187   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1188 1188   }
1189 1189   ],
1190 -
1191 - "statusHistory": [ ~/~/ История статусов
1169 +"statusHistory": [ ~/~/ История статусов
1192 1192   {
1193 1193   "status": 0,
1194 1194   "date": "2023-05-22T09:57:39.562Z",
... ... @@ -1196,7 +1196,6 @@
1196 1196   "additionalInfo": "string"
1197 1197   }
1198 1198   ]
1199 -
1200 1200  }
1201 1201  )))
1202 1202  
... ... @@ -1206,6 +1206,75 @@
1206 1206  (% style="text-align:left" %)
1207 1207  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1208 1208  
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": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1198 +"command": "", ~/~/ Текст отправляемой команды
1199 +"retries": "", ~/~/ Количество попыток отправки на терминал
1200 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1201 +}
1202 +
1203 +В ответ получаем cmdid
1204 +
1205 +
1206 +== **Получить ответ на отправленную на ТС команду** ==
1207 +
1208 +(% class="box infomessage" %)
1209 +(((
1210 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1211 +)))
1212 +
1213 +Идентификатор команды: cmdId
1214 +
1215 +Запрос от терминала на ответ команды
1216 +
1217 +Пример ответ от терминала:
1218 +
1219 +ID= "" ~/~/ идентификатор объекта
1220 +Soft="" ~/~/ версия софта
1221 +GPS=4 ~/~/ тип трекера
1222 +Time=11:05:43 28.06.24 ~/~/ время запроса
1223 +Lat=45.056221 ~/~/ широта
1224 +Lon=39.035938 ~/~/ долгота
1225 +Speed=0.0 ~/~/ скорость
1226 +Course=181.4 ~/~/направление
1227 +
1228 +(((
1229 +== **Список отправленных объекту команд с ответами** ==
1230 +
1231 +(% class="box infomessage" %)
1232 +(((
1233 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1234 +)))
1235 +
1236 +Идентификатор ТС: vehicleId
1237 +
1238 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1239 +
1240 +Пример ответа терминала
1241 +
1242 +[ 
1243 +{    
1244 +"id": "", ~/~/ идентификатор пользователя
1245 +"commandText": "", ~/~/Текст команды.
1246 +"templateId": "", ~/~/Идентификатор шаблона
1247 +"updated": "", ~/~/ Время отправки  
1248 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1249 +"answer": "", ~/~/ Ответ терминала.
1250 +"status": "" ~/~/ Статус отправки
1251 +}
1252 +]
1253 +)))
1254 +
1209 1209  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1210 1210  
1211 1211  (% class="box successmessage" %)
... ... @@ -1223,8 +1223,7 @@
1223 1223  
1224 1224  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1225 1225  
1226 -(% style="color:#000000" %){
1227 -
1272 +(% style="color:#000000" %){(%%)
1228 1228   "parentId": "" , ~/~/ ID клиента
1229 1229   "name": "" , ~/~/ имя ТС
1230 1230   "imei": "" , ~/~/ IMEI
... ... @@ -1245,7 +1245,6 @@
1245 1245   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1246 1246   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1247 1247   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1248 -
1249 1249   "mileageCalcMethod": 0,
1250 1250   "mileageCoeff": 0,
1251 1251   "locationByCellId": true,
... ... @@ -1278,7 +1278,6 @@
1278 1278   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1279 1279   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1280 1280   }
1281 -
1282 1282  "drivers": [ ~/~/ Водители
1283 1283   {
1284 1284   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1293,8 +1293,7 @@
1293 1293   "retries": 0
1294 1294   }
1295 1295   ],
1296 -
1297 - "sensors": [ ~/~/ Датчики
1339 +"sensors": [ ~/~/ Датчики
1298 1298   {
1299 1299   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1300 1300   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1332,41 +1332,43 @@
1332 1332   "additionalProp2": "string",
1333 1333   "additionalProp3": "string"
1334 1334   },
1335 -
1336 1336  ~/~/ Характерные для произвольного:
1337 -
1338 1338  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1339 -
1340 1340  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1341 -
1342 1342  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1343 -
1344 1344  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1345 -
1346 1346  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1347 -
1348 1348  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1349 -
1350 1350  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1351 -
1352 1352  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1353 -
1354 1354  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1355 -
1356 1356  ~/~/ "ValueOn": "Вкл.",
1357 -
1358 1358  ~/~/ "ValueOff": "Выкл."
1359 - "summaryMaxValue": 0 ~/~/ Макс. значение
1389 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1390 +
1391 +(((
1392 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1393 + {
1394 + "from": 0, ~/~/ С какого значения
1395 + "color": "string", ~/~/ Каким цветом
1396 + "text": "string" ~/~/ Текст подписи к этому интервалу
1397 + }
1398 + ]
1360 1360   }
1361 1361   ],
1401 +)))
1402 +
1403 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1404 +
1405 +
1362 1362   "customFields": [ ~/~/ Произвольные поля
1363 1363   {
1364 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1365 - "name": "string",
1366 - "value": "string",
1367 - "forClient": true,
1368 - "forTooltip": true,
1369 - "forReport": true
1408 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1409 + "name": "string", ~/~/ Наименование произвольного поля
1410 + "value": "string", ~/~/ Значение произвольного поля
1411 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1412 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1413 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1370 1370   }
1371 1371   ]
1372 1372  }
... ... @@ -1373,62 +1373,240 @@
1373 1373  
1374 1374  (% style="color:#000000" %)Ответ:
1375 1375  
1376 -(% style="color:#000000" %){
1377 1377  
1378 - "vehicleId": "", ~/~/ID ТС 
1379 - "parentId": "", ~/~/Guid владельца ТС
1380 - "name": "", ~/~/Имя объекта
1381 - "imei": "", ~/~/IMEI
1382 - "deviceTypeId": "", ~/~/ID типа устройства
1383 - "modelId": "", ~/~/ID модели
1384 - "unitId": "", ~/~/ID подразделения
1385 - "sim1": "", ~/~/SIM1
1386 - "sim2": "", ~/~/SIM2
1387 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1388 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1389 - "counters": { ~/~/Счётчики
1390 - "mileageEnabled": true,
1391 - "motohoursEnabled": true,
1392 - "mileage": "",
1393 - "motohours": 345.0
1394 - },
1395 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1396 - "id": null,
1397 - "enabled": true, ~/~/флаг включения
1398 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1399 - "login": "", ~/~/ имя учетной записи
1400 - "password": "" ~/~/ пароль учетной записи
1401 - },
1402 - "inspectionTasks": { ~/~/ задания на ТО
1403 - "id": "", ~/~/ ID задачи
1404 - "enabled": false, ~/~/ Признак включения
1405 - "name": "", ~/~/ Имя задания
1406 - "description": "", ~/~/ Описание задания
1407 - "mileageCondition": "", ~/~/ Условие по пробегу
1408 - "lastMileage": "", ~/~/ Пробег (в метрах)
1409 - "motohoursCondition": "", ~/~/ Условие по моточасам
1410 - "lastMotohours": "", ~/~/ Моточасы
1411 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1412 - "kind": "", ~/~/ Вид периодичности по времени 
1413 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1421 +(((
1422 +(((
1423 +(((
1424 +{
1425 + "vehicleId": 0,  ~/~/ ID ТС
1426 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1427 + "name": "string", ~/~/ Имя объекта
1428 + "imei": "string", ~/~/ IMEI
1429 + "deviceTypeId": 0, ~/~/ ID типа устройства
1430 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1431 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1432 + "sim1": "string", ~/~/ SIM1
1433 + "sim2": "string", ~/~/ SIM2
1434 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1435 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1436 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1437 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1438 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1439 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1440 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1441 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1442 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1443 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1444 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1445 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1446 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1447 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1448 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1449 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1450 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1451 + "counters": {  ~/~/ Dto для состояний счётчиков
1452 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1453 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1454 + "mileage": 0, ~/~/ Пробег
1455 + "motohours": 0 ~/~/ Моточасы
1456 + },
1457 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1458 + "id": "string", ~/~/ CMSV6 Идентификатор
1459 + "enabled": true, ~/~/ Признак включения
1460 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1461 + "login": "string", ~/~/ CMSV6 имя учетной записи
1462 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1463 + },
1464 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1465 + {
1466 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1467 + "enabled": true, ~/~/ Признак включения
1468 + "name": "string", ~/~/ Имя задания
1469 + "description": "string", ~/~/ Описание задания
1470 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1471 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1472 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1473 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1474 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1475 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1476 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1477 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1414 1414   }
1479 + ],
1480 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1481 + {
1482 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1483 + "inputNumber": 0, ~/~/ № входа.
1484 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1485 + "comment": "string", ~/~/ Комментарий
1486 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1487 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1488 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1489 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1490 + }
1491 + ],
1492 + "commandTemplates": [  ~/~/ Список шаблонов команд
1493 + {
1494 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1495 + "name": "string", ~/~/ Название шаблона команд
1496 + "command": "string", ~/~/ Команда на выполнение
1497 + "retries": 0 ~/~/ Лимит попыток отправки
1498 + }
1499 + ],
1500 + "sensors": [ ~/~/ Список датчиков
1501 + {
1502 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1503 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1504 + "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
1505 + "name": "string",  ~/~/ Имя датчика
1506 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1507 + "inputNumber": 0, ~/~/ Номер входа
1508 + "pseudonym": "string", ~/~/ Псевдоним
1509 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1510 + "isInverted": true, ~/~/  Признак инверсии
1511 + "disabled": true, ~/~/ Датчик не участвует в обработке
1512 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1513 + "gradesTables": [ ~/~/ Тарировка
1514 + {
1515 + "grades": [ ~/~/ Таблицы тарировки
1516 + {
1517 + "input": 0, ~/~/ Вход
1518 + "output": 0 ~/~/ Выход
1519 + }
1520 + ],
1521 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1522 + }
1523 + ],
1524 + "showInTooltip": true, ~/~/ Отображение в подсказке
1525 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1526 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1527 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1528 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1529 + "expr": "string", ~/~/ Выражение
1530 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1531 + "string"
1532 + ],
1533 + "customParams": {
1534 + "additionalProp1": "string",
1535 + "additionalProp2": "string",
1536 + "additionalProp3": "string"
1537 + },
1538 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1539 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1540 + {
1541 + "from": 0, ~/~/ С какого значения
1542 + "color": "string", ~/~/ Каким цветом
1543 +)))
1415 1415  
1416 -(% style="text-align:left" %)
1417 -(% style="color:#000000" %)}
1545 +(((
1546 + "text": "string" ~/~/ Текст подписи к этому интервалу
1547 + }
1548 + ]
1549 + }
1550 + ],
1551 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1552 + "customFields": [ ~/~/ Список произвольных полей
1553 + {
1554 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1555 + "name": "string", ~/~/ Наименование произвольного поля
1556 + "value": "string", ~/~/ Значение произвольного поля
1557 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1558 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1559 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1560 + }
1561 + ],
1562 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
1563 +}
1564 +)))
1565 +)))
1566 +)))
1418 1418  
1568 +
1419 1419  **Валидация:**
1420 1420  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1421 1421  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1422 1422  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1423 1423  
1424 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1425 1425  
1575 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1576 +
1577 +(% class="box successmessage" %)
1578 +(((
1579 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1580 +)))
1581 +
1582 +Метод запроса: **POST**
1583 +
1584 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1585 +
1586 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1587 +
1588 +
1589 +Ответ:
1590 +
1591 +{
1592 +
1593 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1594 +
1595 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1596 +
1597 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1598 +
1599 + "Message": "string", ~/~/ Информация о выполнении запроса
1600 +
1601 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1602 +
1603 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1604 +
1605 + "Data": "string" ~/~/ Данные
1606 +
1607 +}
1608 +
1609 +
1610 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1611 +
1426 1426  (% class="box infomessage" %)
1427 1427  (((
1614 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1615 +)))
1616 +
1617 +Метод запроса: **GET**
1618 +
1619 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1620 +
1621 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1622 +
1623 +
1624 +Ответ:
1625 +
1626 +{
1627 +
1628 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1629 +
1630 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1631 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1632 +
1633 + "Message": "string", ~/~/ Информация о выполнении запроса
1634 +
1635 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1636 +
1637 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1638 +
1639 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1640 +
1641 + "Data": "string" ~/~/ Данные
1642 +
1643 +}
1644 +
1645 +
1646 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1647 +
1648 +(% class="box infomessage" %)
1649 +(((
1428 1428  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1429 1429  )))
1430 1430  
1431 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1653 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1432 1432  
1433 1433  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1434 1434  
... ... @@ -1462,9 +1462,12 @@
1462 1462   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1463 1463   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1464 1464   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1465 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1466 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1467 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1687 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1688 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1689 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1690 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1691 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1692 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1468 1468  }
1469 1469  
1470 1470  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1471,8 +1471,14 @@
1471 1471  
1472 1472  (% style="color:#000000" %)Ответ:
1473 1473  
1474 -(% style="color:#000000" %){
1699 +(% style="color:#000000" %)[
1700 +{
1475 1475  
1702 +(((
1703 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1704 +)))
1705 +
1706 +(((
1476 1476  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1477 1477   "name": "" ~/~/ наименование объекта
1478 1478   "imei": "" ~/~/ IMEI объекта
... ... @@ -1498,9 +1498,21 @@
1498 1498   "forClient": true, ~/~/ право на отображение у клиента
1499 1499   "forTooltip": false, ~/~/ право на отображение в подсказке
1500 1500   "forReport": false ~/~/ право на отображение в отчетах
1501 - }(%%)
1502 -(% style="color:#000000" %)}
1732 +)))
1503 1503  
1734 +(((
1735 + }
1736 + ],
1737 + "vehicleGroups": [  ~/~/ Группы ТС
1738 + {
1739 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1740 + "name": "string" ~/~/ Наименование группы ТС
1741 + }
1742 + ]
1743 + }
1744 +]
1745 +)))
1746 +
1504 1504  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1505 1505  
1506 1506  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -1532,13 +1532,11 @@
1532 1532   "data": "", ~/~/ Данные
1533 1533   "overwrite": false, ~/~/ Флаг перезаписи
1534 1534   "stage": "", ~/~/ Состояние, может быть null
1535 -
1536 1536  (% style="color:#000000" %)}
1537 1537  
1538 1538  (% style="color:#000000" %)Ответ:
1539 1539  
1540 -(% style="color:#000000" %){
1541 -
1782 +(% style="color:#000000" %){(%%)
1542 1542   "status": "", ~/~/ значение статуса
1543 1543   "date": "", ~/~/ Дата смены статуса 
1544 1544   "description": "", ~/~/ Описание
... ... @@ -1545,10 +1545,10 @@
1545 1545   "data": "", ~/~/ Данные
1546 1546   "overwrite": false, ~/~/ Флаг перезаписи
1547 1547   "stage": "", ~/~/ Состояние
1548 -
1549 -(% style="text-align:left" %)
1550 1550  (% style="color:#000000" %) }
1551 1551  
1791 +== ==
1792 +
1552 1552  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1553 1553  
1554 1554  (% class="box warningmessage" %)
... ... @@ -1636,8 +1636,7 @@
1636 1636   "retries": 0
1637 1637   }
1638 1638   ],
1639 -
1640 - "sensors": [ ~/~/ Датчики
1880 +"sensors": [ ~/~/ Датчики
1641 1641   {
1642 1642   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1643 1643   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1675,95 +1675,215 @@
1675 1675   "additionalProp2": "string",
1676 1676   "additionalProp3": "string"
1677 1677   },
1678 -
1679 1679  ~/~/ Характерные для произвольного:
1680 -
1681 1681  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1682 -
1683 1683  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1684 -
1685 1685  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1686 -
1687 1687  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1688 -
1689 1689  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1690 -
1691 1691  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1692 -
1693 1693  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1694 -
1695 1695  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1696 -
1697 1697  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1698 -
1699 1699  ~/~/ "ValueOn": "Вкл.",
1700 -
1701 1701  ~/~/ "ValueOff": "Выкл."
1702 1702   "summaryMaxValue": 0 ~/~/ Макс. значение
1931 +
1932 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1933 + {
1934 + "from": 0, ~/~/ С какого значения
1935 + "color": "string", ~/~/ Каким цветом
1936 + "text": "string" ~/~/ Текст подписи к этому интервалу
1937 + }
1938 + ]
1703 1703   }
1704 1704   ],
1941 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1942 +
1705 1705   "customFields": [ ~/~/ Произвольные поля
1706 - {
1707 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1708 - "name": "string",
1709 - "value": "string",
1710 - "forClient": true,
1711 - "forTooltip": true,
1712 - "forReport": true
1944 + {     
1945 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1946 + "name": "string", ~/~/ Наименование произвольного поля
1947 + "value": "string", ~/~/ Значение произвольного поля
1948 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1949 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1950 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1713 1713   }
1714 1714   ]
1715 1715  }
1716 1716  
1955 +
1717 1717  (% style="color:#000000" %)Ответ:
1718 1718  
1719 -(% lang="en-US" style="text-align:left" %)
1720 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1958 +(((
1959 +{
1960 + "vehicleId": 0, ~/~/ ID ТС
1961 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1962 + "name": "string", ~/~/ Имя объекта
1963 + "imei": "string", ~/~/ IMEI
1964 + "deviceTypeId": 0, ~/~/ ID типа устройства
1965 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1966 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1967 + "sim1": "string", ~/~/ SIM1
1968 + "sim2": "string", ~/~/ SIM2
1969 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1970 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1971 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1972 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1973 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1974 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1975 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1976 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1977 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1978 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1979 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1980 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1981 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1982 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1983 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1984 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1985 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1986 + "counters": { ~/~/ состояний счётчиков
1987 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1988 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1989 + "mileage": 0, ~/~/ Пробег
1990 + "motohours": 0 ~/~/ Моточасы 
1991 + },
1992 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1993 + "id": "string", ~/~/ CMSV6 Идентификатор
1994 + "enabled": true, ~/~/ Признак включения
1995 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1996 +)))
1721 1721  
1722 -(% lang="en-US" style="text-align:left" %)
1723 - "vehicleId": "", ~/~/ ID ТС
1724 - "parentId": "", ~/~/ ID клиента
1725 - "name": "", ~/~/ имя ТС
1726 - "imei": "", ~/~/ IMEI
1727 - "deviceTypeId": "", ~/~/ типа устройства
1728 - "modelId": "", ~/~/ ID модели
1729 - "unitId": "", ~/~/ ID подразделения
1730 - "sim1": "", ~/~/ SIM 1
1731 - "sim2": "", ~/~/ SIM2
1732 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1733 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1734 - "counters": 
1735 - {
1736 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1737 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1738 - "mileage": "", ~/~/ пробег
1739 - "motohours": "", ~/~/ моточасы
1740 - }
1741 - "cmsv6Parameters": ~/~/ параметры CMSv6
1998 +
1999 +(((
2000 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2001 + "login": "string", ~/~/ CMSV6 имя учетной записи
2002 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
2003 + },
2004 + "inspectionTasks": [ ~/~/ Задания на ТО
2005 + {
2006 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2007 + "enabled": true, ~/~/ Признак включения
2008 + "name": "string", ~/~/ Имя задания
2009 + "description": "string", ~/~/ Описание задания
2010 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2011 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2012 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2013 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2014 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2015 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2016 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2017 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2018 + }
2019 + ],
2020 + "drivers": [  ~/~/ Список водителей
2021 + {
2022 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2023 + "inputNumber": 0, ~/~/ № входа.
2024 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2025 + "comment": "string", ~/~/ Комментарий.
2026 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2027 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2028 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2029 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2030 + }
2031 + ],
2032 + "commandTemplates": [ ~/~/ Список шаблонов команд
2033 + {
2034 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2035 + "name": "string", ~/~/ Название шаблона команд
2036 + "command": "string", ~/~/ Команда на выполнение
2037 + "retries": 0 ~/~/ Лимит попыток отправки
2038 + }
2039 + ],
2040 + "sensors": [  ~/~/ Список датчиков 
2041 + {
2042 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2043 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2044 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2045 +)))
2046 +
2047 +(((
2048 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2049 +)))
2050 +
2051 +(((
2052 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2053 +)))
2054 +
2055 +(((
2056 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2057 +)))
2058 +
2059 +(((
2060 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2061 +)))
2062 +
2063 +(((
2064 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2065 + "name": "string", ~/~/ Имя датчика
2066 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2067 +)))
2068 +
2069 +(((
2070 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2071 + "inputNumber": 0, ~/~/ Номер входа
2072 + "pseudonym": "string", ~/~/ Псевдоним
2073 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2074 + "isInverted": true, ~/~/ Признак инверсии
2075 + "disabled": true, ~/~/ Датчик не участвует в обработке
2076 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2077 + "gradesTables": [ ~/~/ Тарировка
1742 1742   {
1743 - "id": ~/~/ идентификатор
1744 - "enabled": true, ~/~/ флаг включения
1745 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1746 - "login": "", ~/~/ имя учетной записи
1747 - "password": "", ~/~/ пароль учетной записи
1748 - }
1749 - "inspectionTasks": ~/~/ задания на ТО
2079 + "grades": [ ~/~/ Таблицы тарировки
2080 + {
2081 + "input": 0, ~/~/ Вход
2082 + "output": 0 ~/~/ Выход
2083 + }
2084 + ],
2085 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2086 + }
2087 + ],
2088 + "showInTooltip": true, ~/~/ Отображение в подсказке
2089 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
2090 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2091 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2092 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2093 + "expr": "string", ~/~/ Выражение
2094 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2095 + "string" 
2096 + ],
2097 + "customParams": { ~/~/ Дополнительные настройки
2098 + "additionalProp1": "string",
2099 + "additionalProp2": "string",
2100 + "additionalProp3": "string"
2101 + },
2102 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2103 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1750 1750   {
1751 - "id": "", ~/~/ ID задания
1752 - "enabled": false, ~/~/ Признак включения
1753 - "name": "", ~/~/ Имя задания
1754 - "description": "", ~/~/ Описание задания
1755 - "mileageCondition": "", ~/~/ Условие по пробегу
1756 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1757 - "motohoursCondition": "", ~/~/ Условие по моточасам
1758 - "lastMotohours": "", ~/~/ Моточасы
1759 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1760 - "kind": "", ~/~/ Вид периодичности по времени
1761 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2105 + "from": 0, ~/~/ С какого значения
2106 + "color": "string", ~/~/ Каким цветом
2107 + "text": "string" ~/~/ Текст подписи к этому интервалу
1762 1762   }
2109 + ]
2110 + }
2111 + ],
2112 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2113 + "customFields": [ ~/~/ Список произвольных полей
2114 + {
2115 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2116 + "name": "string", ~/~/ Наименование произвольного поля
2117 + "value": "string", ~/~/ Значение произвольного поля
2118 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2119 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2120 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2121 + }
2122 + ],
2123 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2124 +}
2125 +)))
1763 1763  
1764 -(% lang="en-US" style="text-align:left" %)
1765 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1766 -
1767 1767  **Валидация:**
1768 1768  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1769 1769  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -1808,12 +1808,9 @@
1808 1808  
1809 1809  (% style="color:#000000" %)Ответ:
1810 1810  
1811 -(% style="color:#000000" %){
1812 -
2171 +(% style="color:#000000" %){(%%)
1813 1813   "deviceTypeId" : "", ~/~/ ID типа устройства
1814 1814   "deviceTypeName" : "" ~/~/ Название типа устройства
1815 -
1816 -(% style="text-align:left" %)
1817 1817  (% style="color:#000000" %)}
1818 1818  
1819 1819  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1835,13 +1835,10 @@
1835 1835  
1836 1836  (% style="color:#000000" %)Ответ:
1837 1837  
1838 -(% style="color:#000000" %){
1839 -
2195 +(% style="color:#000000" %){(%%)
1840 1840   "id": "", ~/~/ ID типа датчика 
1841 1841   "name": "", ~/~/ Название
1842 1842   "description": "", ~/~/ Описание
1843 -
1844 -(% style="text-align:left" %)
1845 1845  (% style="color:#000000" %)}
1846 1846  
1847 1847  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -2043,10 +2043,12 @@
2043 2043   {
2044 2044   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2045 2045   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2046 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2047 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2048 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2049 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2400 + "mileage": 0, ~/~/ Пробег за период, километры
2401 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2402 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2403 + "motohours": 0, ~/~/ Моточасы за период, секунды
2404 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2405 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2050 2050   }
2051 2051   ]
2052 2052   }
... ... @@ -2095,6 +2095,12 @@
2095 2095   }
2096 2096  ]
2097 2097  
2454 +(% class="box warningmessage" %)
2455 +(((
2456 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2457 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2458 +)))
2459 +
2098 2098  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2099 2099  
2100 2100  (% class="box infomessage" %)
... ... @@ -2158,74 +2158,42 @@
2158 2158  Тело запроса:
2159 2159  
2160 2160  {
2161 -
2162 2162   "vehicleIds": [ ], ~/~/ Список ID объектов
2163 -
2164 2164   "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2165 -
2166 2166   "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2167 -
2168 2168   "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2169 -
2170 2170  }
2171 2171  
2172 2172  Ответ:
2173 2173  
2174 -[
2175 -
2531 +[ 
2176 2176   {
2177 -
2178 2178   "vehicleId": 0, ~/~/ ID объекта
2179 -
2180 2180   "vehicleName": "string", ~/~/ Имя объекта
2181 -
2182 2182   "moves": [ ~/~/ Событие движения
2183 -
2184 2184   {
2185 -
2186 2186   "mileage": 0, ~/~/ Пробег, км
2187 -
2188 2188   "eventId": 0, ~/~/ Идентификатор события
2189 -
2190 2190   "eventName": "string", ~/~/ Название события
2191 -
2192 2192   "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2193 -
2194 2194   "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2195 -
2196 2196   "duration": 0 ~/~/ Продолжительность события, секунд
2197 -
2198 2198   }
2199 -
2200 2200   ],
2201 -
2202 2202   "stops": [ ~/~/ События стоянок
2203 -
2204 2204   {
2205 -
2206 - "address": "string", ~/~/ Адрес события
2207 -
2547 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2208 2208   "eventId": 0, ~/~/ Идентификатор события
2209 -
2210 2210   "eventName": "string", ~/~/ Название события
2211 -
2212 2212   "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2213 -
2214 2214   "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2215 -
2216 2216   "duration": 0 ~/~/ Продолжительность события, секунд
2217 -
2218 -
2219 2219   }
2220 -
2221 2221   ]
2222 -
2223 2223   }
2224 -
2225 2225  ]
2226 2226  
2227 2227  
2228 -
2229 2229  == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2230 2230  
2231 2231  (% class="box infomessage" %)
... ... @@ -2262,7 +2262,6 @@
2262 2262   }
2263 2263  
2264 2264  
2265 -
2266 2266  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2267 2267  
2268 2268  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2570,6 +2570,32 @@
2570 2570  
2571 2571  Success
2572 2572  
2902 +
2903 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2904 +
2905 +(% class="box warningmessage" %)
2906 +(((
2907 +**PUT** /api/v3/notifications/prolongation
2908 +)))
2909 +
2910 +Метод позволяет продлить уведомления.
2911 +
2912 +Метод запроса **PUT**
2913 +
2914 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2915 +
2916 +В заголовках запроса: X-Auth: Токен авторизации.
2917 +
2918 +Тело запроса:
2919 +
2920 +[
2921 +
2922 +0
2923 +
2924 +]
2925 +
2926 +где 0 идентификатор ids.
2927 +
2573 2573  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2574 2574  
2575 2575  (% class="box errormessage" %)
... ... @@ -3760,7 +3760,7 @@
3760 3760  **POST /api/v3/vehicles/import/{agentId}**
3761 3761  )))
3762 3762  
3763 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
4118 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3764 3764  
3765 3765  В пути указывается **agentId** - id клиента.
3766 3766  
... ... @@ -3772,7 +3772,7 @@
3772 3772  
3773 3773  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3774 3774  |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3775 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
4130 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3776 3776  
3777 3777  В теле использовать тип **form-data,** тип значения** file**
3778 3778  
... ... @@ -3951,64 +3951,67 @@
3951 3951  Тело запроса:
3952 3952  
3953 3953  {
3954 - "vehicleIds": [vehicleId],
3955 - "from": "2023-11-22T09:29:48.051Z",
3956 - "to": "2023-11-22T09:29:48.051Z"
4309 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4310 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4311 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
3957 3957  }
3958 3958  
3959 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3960 -|vehicleIds|Массив ID объектов
3961 -|from|Дата начала запроса
3962 -|to|Дата окончания запроса
3963 -
3964 3964  Ответ:
3965 3965  
3966 3966  {
3967 - "items": [
4317 + "items": [  ~/~/ Список в разрезе ТС
3968 3968   {
3969 - "from": "2023-11-22T09:29:48.052Z",
3970 - "to": "2023-11-22T09:29:48.052Z",
3971 - "vehicleId": 0,
3972 - "vehicleName": "string",
3973 - "vehicleModel": "string",
3974 - "penalty": 0,
3975 - "score": 0,
3976 - "totalViolations": 0,
3977 - "violationsByType": {
3978 - "overspeedingViolations": 0,
3979 - "accelerationViolations": 0,
3980 - "brakingViolations": 0,
3981 - "turningViolations": 0,
3982 - "dangerousDrivingViolations": 0,
3983 - "sensorViolations": 0
4319 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4320 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4321 + "vehicleId": 0, ~/~/ ID ТС
4322 + "vehicleName": "string", ~/~/ Название ТС
4323 + "vehicleModel": "string", ~/~/ Модель ТС
4324 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4325 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4326 + "totalViolations": 0, ~/~/ Нарушений всего
4327 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4328 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4329 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4330 + "brakingViolations": 0, ~/~/ Нарушений торможения
4331 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4332 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4333 + "sensorViolations": 0 ~/~/ Нарушений по датчику
3984 3984   },
3985 - "moveTime": 0,
3986 - "mileage": 0,
3987 - "tripsCount": 0,
3988 - "trips": [
4335 +
4336 +(((
4337 +
4338 +)))
4339 +
4340 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4341 + "mileage": 0, ~/~/ Пробег, м
4342 + "tripsCount": 0, ~/~/ Кол-во рейсов
4343 + "trips": [  ~/~/ Информация по рейсу
3989 3989   {
3990 - "penalty": 0,
3991 - "score": 0,
3992 - "violationsCount": 0,
3993 - "violationsByType": {
3994 - "overspeedingViolations": 0,
3995 - "accelerationViolations": 0,
3996 - "brakingViolations": 0,
3997 - "turningViolations": 0,
3998 - "dangerousDrivingViolations": 0,
3999 - "sensorViolations": 0
4345 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4346 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4347 + "violationsCount": 0, ~/~/ Всего нарушений
4348 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4349 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4350 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4351 + "brakingViolations": 0, ~/~/ Нарушений торможения
4352 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4353 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4354 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4000 4000   },
4001 - "moveTime": 0,
4002 - "mileage": 0,
4003 - "motohours": 0,
4004 - "maxSpeed": 0,
4005 - "startAddress": "string",
4006 - "endAddress": "string",
4007 - "drivers": [
4356 +
4357 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4358 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4359 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4360 + "mileage": 0, ~/~/ Пробег, м
4361 + "motohours": 0, ~/~/ Моточасы, секунды
4362 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4363 + "startAddress": "string", ~/~/ Адрес начала рейса
4364 + "endAddress": "string", ~/~/ Адрес конца рейса
4365 + "drivers": [  ~/~/ Список водителей
4008 4008   {
4009 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4010 - "driverName": "string",
4011 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4367 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4368 + "driverName": "string", ~/~/ФИО водителя
4369 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4012 4012   }
4013 4013   ]
4014 4014   }
... ... @@ -4017,104 +4017,308 @@
4017 4017   ]
4018 4018  }
4019 4019  
4020 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4021 -|from|Дата начала запроса
4022 -|to|Дата  окончания
4023 -|vehicleId|ID объекта
4024 -|vehicleName|Имя объекта
4025 -|vehicleModel|Модель объекта
4026 -|penalty|Сумма штрафных баллов
4027 -|score|Оценка
4028 -|totalViolations|Суммарное количество нарушений
4029 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4030 -|overspeedingViolations|Превышение скорости
4031 -|accelerationViolations|Ускорение
4032 -|brakingViolations|Торможение
4033 -|turningViolations|Резкий поворот
4034 -|dangerousDrivingViolations|Резкое вождение
4035 -|sensorViolations|Нарушение по датчику
4036 -|moveTime|Время в движении
4037 -|mileage|Пробег
4038 -|tripsCount|Количество рейсов
4039 -|motohours|Моточасы
4040 -|maxSpeed|Максимальная скорость
4041 -|startAddress|Адрес начала рейса
4042 -|endAddress|Адрес окончания рейса
4043 -|drivers|Список водителей, которые были на объекте в течениии рейса
4044 -|driverGuid|Guid водителя
4045 -|driverName|Имя водителя
4046 -|driverRfid|Номер Карты-метки
4047 -
4048 4048  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4049 4049  
4050 4050  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4051 4051  
4052 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
4382 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4053 4053  
4054 4054  (% class="box infomessage" %)
4055 4055  (((
4056 -**POST**/api/v3/fuelcards/transactions
4386 +POST /api/v3/fuelcards/transactions
4057 4057  )))
4058 4058  
4059 -Запрос должен содержать параметры:
4389 +Метод запроса: POST
4060 4060  
4391 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4392 +\\В заголовках запроса: X-Auth: Токен авторизации
4393 +
4394 +Параметры в теле запроса (JSON):
4395 +
4061 4061  {
4397 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4398 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4399 + "ids": [ 
4400 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4401 + ],
4402 + "timezone": 0 ~/~/Таймзона
4403 +}
4062 4062  
4063 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
4064 4064  
4065 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
4406 +Ответ:
4407 + {
4408 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4409 + "driver": "string", ~/~/Водители, привязанные к ТК
4410 + "object": "string", ~/~/Наименование ТС
4411 + "amount": 0, ~/~/Количество топлива
4412 + "amountDut": 0, ~/~/Количество по ДУТ
4413 + "amountDiff": 0, ~/~/Разница, л
4414 + "amountDiffPerc": 0, ~/~/Разница, %
4415 + "summa": 0, ~/~/Стоимость, руб
4416 + "serviceName": "string", ~/~/Тип топлива
4417 + "price": 0, ~/~/Цена за литр, руб
4418 + "cardName": "string", ~/~/Наименование ТК
4419 + "cardNum": "string", ~/~/Номер ТК
4420 + "operator": "string", ~/~/Оператор ТК
4421 + "address": "string" ~/~/Адрес АЗС
4422 + }
4066 4066  
4067 - "ids": [
4068 4068  
4069 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
4425 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4070 4070  
4071 - ],
4072 4072  
4073 - "timezone": 0, ~/~/ Часовой пояс
4428 +== **Получение полных данных о ретрансляторе** ==
4074 4074  
4075 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
4430 +(% class="box infomessage" %)
4431 +(((
4432 +**GET ** **/api/v3/retranslations/{id}**
4433 +)))
4076 4076  
4435 +Идентификатор запроса: ID
4436 +
4437 +
4438 +Пример ответа:
4439 +
4440 +{  
4441 +"description": "", ~/~/ Поле описания ретранслятора
4442 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4443 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4444 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4445 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4446 +"objects": [ ~/~/ Объекты для ретрансляции
4447 +{      
4448 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4449 +"name": "", ~/~/ Наименование объекта ретрансляции
4450 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4451 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4077 4077  }
4453 + ],  
4454 +"id": "", ~/~/ Идентификатор ретранслятора 
4455 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4456 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4457 +}
4078 4078  
4459 +
4460 +== **Удаление данных ретранслятора** ==
4461 +
4462 +(% class="box infomessage" %)
4463 +(((
4464 +**DELETE** **/api/v3/retranslations/{id}**
4465 +)))
4466 +
4467 +Параметр запроса: ID - Идентификатор ретранслятора
4468 +
4469 +
4470 +== **Создание ретранслятора** ==
4471 +
4472 +(% class="box infomessage" %)
4473 +(((
4474 +**POST ** **/api/v3/retranslations/{id}**
4475 +)))
4476 +
4477 +Запрос:
4478 +
4479 +{  
4480 +"description": "", ~/~/ Поле описания ретранслятора
4481 +"subscriberId": "", ~/~/ Идентификатор подписчика
4482 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4483 +"address": "", ~/~/ Адрес и порт принимающего сервера
4484 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4485 +"objects": [ ~/~/Объекты для ретрансляции
4486 +{      
4487 +"id": "", ~/~/ Идентификатор ретранслятора 
4488 +"imei": "", ~/~/ IMEI объекта ретрансляции
4489 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4490 +}
4491 + ]
4492 +}
4493 +
4494 +
4079 4079  Ответ:
4080 4080  
4081 - {
4497 +{  
4498 +"description": "", ~/~/ Поле описания ретранслятора
4499 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4500 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4501 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4502 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4503 +"objects": [ ~/~/ Объекты для ретрансляции
4504 +{      
4505 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4506 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4507 +"imei": "", ~/~/ IMEI объекта ретрансляции
4508 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4509 +}
4510 + ],
4511 +"id": "", ~/~/ Идентификатор ретранслятора   
4512 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4513 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4514 +}
4082 4082  
4083 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
4084 4084  
4085 - " driver ": "string", ~/~/ Имя водителя
4517 +== **Редактирование ретранслятора** ==
4086 4086  
4087 - "amount": 0, ~/~/ Количество топлива
4519 +(% class="box infomessage" %)
4520 +(((
4521 +**PUT** **/api/v3/retranslations**
4522 +)))
4088 4088  
4089 - "amountDut": 0, ~/~/ Количество топлива по ДУТ
4524 +Пример запроса:
4090 4090  
4091 - "amountDiff": 0, ~/~/ Разница в литрах
4526 +{  
4527 +"id": "", ~/~/ Идентификатор ретранслятора   
4528 +"description": "string", ~/~/ Поле описания ретранслятора
4529 +"subscriberId": "", ~/~/ Идентификатор подписчика
4530 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4531 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4532 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4533 +"objects": ~/~/ Объекты для ретрансляции
4534 +[    
4535 +{      
4536 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4537 +"imei": "", ~/~/ IMEI объекта ретрансляции
4538 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4539 +}
4540 + ]
4541 +}
4092 4092  
4093 - "amountDiffPerc": 0, ~/~/ Разница в %
4094 4094  
4095 - "summa": 0, ~/~/  Стоимость в руб.
4544 +Пример ответа:
4096 4096  
4097 - "serviceName": "string", ~/~/ Тип топлива
4546 +{  
4547 +"description": "", ~/~/ Поле описания ретранслятора
4548 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4549 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4550 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4551 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4552 +"objects": [ ~/~/ Объекты для ретрансляции
4553 +{      
4554 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4555 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4556 +"imei": "", ~/~/ IMEI объекта ретрансляции
4557 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4558 +}
4559 + ],
4560 +"id": "", ~/~/ Идентификатор ретранслятора   
4561 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4562 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4563 +}
4098 4098  
4099 - "price": 0, ~/~/ Цена за литр в руб.
4100 4100  
4101 - "cardName": "string", ~/~/ Наименование ТК
4566 +== **Получение списка ретранслятора клиента** ==
4102 4102  
4103 - "cardNum": "string", ~/~/ Номер ТК
4568 +(% class="box infomessage" %)
4569 +(((
4570 +**POST /api/v3/retranslations/find**
4571 +)))
4104 4104  
4105 - "operator": "string", ~/~/ Оператор ТК
4573 +Пример запроса:
4106 4106  
4107 - "address": "string", ~/~/ Адрес АЗС
4575 +{  
4576 +"id": "", ~/~/ Идентификатор ретранслятора   
4577 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4578 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (вышестоящего клиента).
4579 +}
4108 4108  
4109 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
4581 +Ответ:
4110 4110  
4583 +[ 
4584 +{    
4585 +"description": "", ~/~/ Поле описания ретранслятора
4586 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4587 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4588 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4589 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4590 +"id": "", ~/~/ Идентификатор ретранслятора   
4591 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4592 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4593 +}
4594 +]
4595 +
4596 +
4597 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4598 +
4599 +== **API для отчета по выгрузке комбайнов** ==
4600 +
4601 +(% class="box infomessage" %)
4602 +(((
4603 +POST **/api/v3/Reports/harvesterUnloading**
4604 +)))
4605 +
4606 +Пример запроса:
4607 +
4608 +{
4609 + "byTime": 0, ~/~/ Объединение событий по времени
4610 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4611 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4612 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4613 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4614 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4615 + 0
4616 + ],
4617 + "from": "", ~/~/ Дата и время начало запроса
4618 + "to": "", ~/~/ Дата и время окончания запроса
4619 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4620 +}
4621 +
4622 +Пример ответа:
4623 +
4624 +[ 
4625 + {
4626 + "harvesterName": "", ~/~/Комбайн, номер
4627 + "harvesterId": 0, ~/~/Комбайн, id
4628 +"harvesterModel": "", ~/~/ Модель комбайна
4629 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4630 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4631 + "events": [ ~/~/Список событий в разрезе комбайна
4632 + {
4633 + "driverId": "", ~/~/Идентификатор водителя
4634 + "driverName": "", ~/~/Водитель комбайна, ФИО
4635 + "RFID": "", ~/~/ идентификатор карты-метки
4636 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4637 + "vehicleId": 0, ~/~/идентификатор объекта
4638 + "vehicleName": "string", ~/~/ Имя объекта
4639 + "modelName": "string", ~/~/ Имя модели объекта
4640 + "nearestVehicles": [ ~/~/Объекты рядом
4641 + {
4642 + "vehicleId": 0, ~/~/идентификатор объекта
4643 + "vehicleName": "string" ~/~/ Имя объекта
4644 + }
4645 + ],
4646 + "fields": [ ~/~/Поля, где происходила выгрузка
4647 + {
4648 + "id": 0, ~/~/ идентификатор пользователя 
4649 + "name": "string" ~/~/ имя пользователя 
4650 + }
4651 + ],
4652 + "event": "string", ~/~/Событие
4653 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4654 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4655 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4656 + "cultureName": "string", ~/~/ название культуры
4657 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4658 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4659 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4660 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4661 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4662 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4663 + "issued": 0, ~/~/Выдано, бункеров
4664 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4665 + "latitude": 0, ~/~/Широта
4666 + "longitude": 0, ~/~/ Долгота
4667 + "litresAway": 0, ~/~/Отдано, л
4668 + "m3Away": 0 ~/~/Отдано, м3
4669 + }
4670 + ]
4111 4111   }
4672 +]
4112 4112  
4113 4113  
4114 -Раздел: Корзина
4675 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4115 4115  
4116 -Запрос на получение списка всех объектов в корзине
4677 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4117 4117  
4679 +
4118 4118  (% class="box infomessage" %)
4119 4119  (((
4120 4120  GET api/v3/Vehicles/recyclebin/all
... ... @@ -4128,36 +4128,32 @@
4128 4128  
4129 4129  Ответ:
4130 4130  
4131 -"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
4132 -"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
4133 -"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
4134 -"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
4135 -"objectType": "Vehicle", - Тип объекта
4136 -"details": {
4137 -"items": [ {
4138 -"name": "ObjectName", - наименование столбца
4139 -"value": "01" - содержание столбца
4140 -},
4693 +[ 
4694 + {
4695 + "recordTime": "", ~/~/Время записи
4696 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4697 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4698 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4699 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4700 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4701 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4702 + "items": [ ~/~/ 
4703 +nullable: true ~/~/Детали
4704 + {
4705 + "name": "string", ~/~/наименование столбца
4706 + "value": "string" ~/~/содержание столбца
4707 + }
4708 + ]
4709 + },
4710 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4711 + "string"
4712 + ]
4713 + }
4714 +]
4141 4141  
4142 -{
4143 -"parentName": "string",
4144 -"name": "string",
4145 -"picture": "string",
4146 -"minspeed": 0,
4147 -"maxspeed": 0,
4148 -"width": 0,
4149 -"imbeddedtrailer": true,
4150 -"hoppercapacity": 0,
4151 -"hopperdischargespeed": 0,
4152 -"modelType": 0,
4153 -"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4154 -"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4155 -"deleted": true
4156 -}
4157 4157  
4717 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4158 4158  
4159 -Запрос на удаление объектов из корзины
4160 -
4161 4161  (% class="box infomessage" %)
4162 4162  (((
4163 4163  POST/api/v3/Vehicles/recyclebin/erase
... ... @@ -4165,17 +4165,41 @@
4165 4165  
4166 4166  В заголовках запроса: X-Auth: Токен авторизации
4167 4167  
4168 -Параметры в теле запроса (JSON):
4726 +Пример запроса:
4727 +
4169 4169  [
4170 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4171 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4729 +0
4172 4172  ]
4731 +
4173 4173  
4174 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4733 +Пример ответа:
4175 4175  
4735 +[ 
4736 +{
4737 + "recordTime": "", ~/~/Время записи
4738 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4739 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4740 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4741 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4742 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4743 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4744 + "items": [ ~/~/Детали
4745 + {
4746 + "name": "", ~/~/Имя свойства
4747 + "value": "" ~/~/Значение свойства
4748 + }
4749 + ]
4750 + },
4751 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4752 + ""
4753 + ]
4754 + }
4755 +]
4176 4176  
4177 -Запрос на восстановление объектов из корзины
4757 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4178 4178  
4759 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4760 +
4179 4179  (% class="box infomessage" %)
4180 4180  (((
4181 4181  POST/api/v3/Vehicles/recyclebin/restore
... ... @@ -4184,15 +4184,53 @@
4184 4184  В заголовках запроса: X-Auth: Токен авторизации
4185 4185  
4186 4186  Параметры в теле запроса (JSON):
4769 +
4770 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4771 +
4772 +В заголовках запроса: X-Auth: Токен авторизации
4773 +
4774 +
4775 +Пример запроса:
4776 +
4777 +(((
4187 4187  [
4188 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4189 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4779 +)))
4780 +
4781 +(((
4782 + 0
4783 +)))
4784 +
4785 +(((
4190 4190  ]
4787 +)))
4191 4191  
4192 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4193 4193  
4790 +Пример ответа:
4194 4194  
4792 +[
4793 +{
4794 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4795 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4796 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4797 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4798 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4799 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4800 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4801 + "items": [ ~/~/Детали
4802 + {
4803 + "name": "string", ~/~/Имя свойства
4804 + "value": "string" ~/~/Значение свойства
4805 + }
4806 + ]
4807 + },
4808 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4809 + "string"
4810 + ]
4811 + }
4812 +]
4195 4195  
4814 +
4815 +
4196 4196  (% class="box" lang="en-US" style="text-align: center;" %)
4197 4197  (((
4198 4198  (% 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 г.