Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 126.1 >
edited by Илья Крайнов
on 2023/11/29 10:18
To version < 164.1 >
edited by Михаил Жучков
on 2024/08/09 14:29
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.SupportZhuchkov
Content
... ... @@ -16,6 +16,11 @@
16 16  
17 17  (% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 +
20 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
21 +
22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
... ... @@ -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" %)
52 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
53 + "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  
64 +(% class="wikigeneratedid" %)
65 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
66 +
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 пользователя
439 +{     
440 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя
457 +}
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 -
479 +(% 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 пользователя 
575 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
576 + "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" %)
598 + "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": "" , ~/~/ идентификатор пользователя
605 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
606 + "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» названия группы пользователя
627 +}
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 -
648 +(% 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",
673 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
694 694   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
695 695   ]
696 696  
... ... @@ -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 -
1046 + "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": [ ~/~/ История статусов
1153 +"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  
1170 +
1171 +== **Отправить команду на терминал** ==
1172 +
1173 +(% class="box successmessage" %)
1174 +(((
1175 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1176 +)))
1177 +
1178 +Команда для отправки на тс.
1179 +
1180 +{  
1181 +"id": "", ~/~/идентификатор произвольного поля
1182 +"command": "", ~/~/ Текст команды
1183 +"retries": "", ~/~/ Количество попыток
1184 +"idTemplate": "" ~/~/ ID шаблона команды
1185 +}
1186 +
1187 +
1188 +== **Получить ответ на отправленную на ТС команду** ==
1189 +
1190 +(% class="box infomessage" %)
1191 +(((
1192 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1193 +)))
1194 +
1195 +Идентификатор команды: cmdid
1196 +
1197 +Запрос от терминала на ответ команды
1198 +
1199 +Пример ответ от терминала:
1200 +
1201 +ID= "" ~/~/ идентификатор произвольного поля
1202 +Soft="" ~/~/ версия софта
1203 +GPS=4 ~/~/ тип трекера
1204 +Time=11:05:43 28.06.24 ~/~/ время запроса
1205 +Lat=45.056221 ~/~/ широта
1206 +Lon=39.035938 ~/~/ долгота
1207 +Speed=0.0 ~/~/ скорость
1208 +Course=181.4 ~/~/направление
1209 +
1210 +(((
1211 +== **Список отправленных объекту команд с ответами** ==
1212 +
1213 +(% class="box infomessage" %)
1214 +(((
1215 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1216 +)))
1217 +
1218 +Идентификатор ТС: vehicleId
1219 +
1220 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1221 +
1222 +Пример ответа терминала
1223 +
1224 +[ 
1225 +{    
1226 +"id": "", ~/~/ идентификатор пользователя
1227 +"commandText": "", ~/~/Текст команды.
1228 +"templateId": "", ~/~/Идентификатор шаблона
1229 +"updated": "", ~/~/ Время отправки  
1230 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1231 +"answer": "", ~/~/ Ответ терминала.
1232 +"status": "" ~/~/ Статус отправки
1233 +}
1234 +]
1235 +)))
1236 +
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 -
1254 +(% 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": [ ~/~/ Датчики
1321 +"sensors": [ ~/~/ Датчики
1300 1300   {
1301 1301   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1302 1302   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1334,29 +1334,17 @@
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 1361   "summaryMaxValue": 0 ~/~/ Макс. значение
1362 1362   }
... ... @@ -1375,8 +1375,7 @@
1375 1375  
1376 1376  (% style="color:#000000" %)Ответ:
1377 1377  
1378 -(% style="color:#000000" %){
1379 -
1388 +(% style="color:#000000" %){(%%)
1380 1380   "vehicleId": "", ~/~/ID ТС 
1381 1381   "parentId": "", ~/~/Guid владельца ТС
1382 1382   "name": "", ~/~/Имя объекта
... ... @@ -1414,8 +1414,6 @@
1414 1414   "kind": "", ~/~/ Вид периодичности по времени 
1415 1415   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1416 1416   }
1417 -
1418 -(% style="text-align:left" %)
1419 1419  (% style="color:#000000" %)}
1420 1420  
1421 1421  **Валидация:**
... ... @@ -1430,7 +1430,7 @@
1430 1430  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1431 1431  )))
1432 1432  
1433 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1440 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1434 1434  
1435 1435  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1436 1436  
... ... @@ -1474,8 +1474,7 @@
1474 1474  (% style="color:#000000" %)Ответ:
1475 1475  
1476 1476  (% style="color:#000000" %){
1477 -
1478 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1484 + "vehicleId": "" ~/~/ идентификатор объекта
1479 1479   "name": "" ~/~/ наименование объекта
1480 1480   "imei": "" ~/~/ IMEI объекта
1481 1481   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -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 -
1547 +(% 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  
1556 +== ==
1557 +
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": [ ~/~/ Датчики
1645 +"sensors": [ ~/~/ Датчики
1643 1643   {
1644 1644   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1645 1645   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1677,29 +1677,17 @@
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 ~/~/ Макс. значение
1705 1705   }
... ... @@ -1719,9 +1719,7 @@
1719 1719  (% style="color:#000000" %)Ответ:
1720 1720  
1721 1721  (% lang="en-US" style="text-align:left" %)
1722 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1723 -
1724 -(% lang="en-US" style="text-align:left" %)
1713 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1725 1725   "vehicleId": "", ~/~/ ID ТС
1726 1726   "parentId": "", ~/~/ ID клиента
1727 1727   "name": "", ~/~/ имя ТС
... ... @@ -1762,8 +1762,6 @@
1762 1762   "kind": "", ~/~/ Вид периодичности по времени
1763 1763   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1764 1764   }
1765 -
1766 -(% lang="en-US" style="text-align:left" %)
1767 1767  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1768 1768  
1769 1769  **Валидация:**
... ... @@ -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]]
1794 +(% 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 -
1800 +(% 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 -
1824 +(% 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|Номер входа
1914 +|inputNumber|(((
1915 +Номер входа
1916 +)))
1934 1934  
1918 +(% class="wikigeneratedid" %)
1919 +Перечень 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/]]
1920 +
1935 1935  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1936 1936  
1937 1937  (% class="box infomessage" %)
... ... @@ -1956,6 +1956,11 @@
1956 1956   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1957 1957  }
1958 1958  
1945 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1946 +|vehicleId|ID объекта
1947 +|from|Дата и время начала периода запроса
1948 +|to|Дата и время окончания периода запроса
1949 +
1959 1959  Ответ:
1960 1960  
1961 1961  [
... ... @@ -1962,25 +1962,43 @@
1962 1962   {
1963 1963   "messages": [
1964 1964   {
1965 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1966 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1967 - "speed": 0, ~/~/ Скорость, км/ч
1968 - "altitude": 0, ~/~/ Высота, м
1969 - "latitude": 0, ~/~/ Широта [-90°;90°]
1970 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1971 - "satellites": 0, ~/~/ Кол-во спутников
1972 - "voltage": 0, ~/~/ Напряжение
1973 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1956 + "deviceTime": "2023-11-29T07:40:44.052Z",
1957 + "serverTime": "2023-11-29T07:40:44.052Z",
1958 + "speed": 0,
1959 + "altitude": 0,
1960 + "latitude": 0,
1961 + "longitude": 0,
1962 + "satellites": 0,
1963 + "course": 0,
1964 + "voltage": 0,
1965 + "parameters": {
1974 1974   "additionalProp1": "string",
1975 1975   "additionalProp2": "string",
1976 1976   "additionalProp3": "string"
1977 1977   },
1978 - "photoCount": 0 ~/~/ Кол-во фото
1970 + "photoCount": 0,
1971 + "lbsCorrectedCoords": true,
1972 + "protocolType": 0
1979 1979   }
1980 1980   ]
1981 1981   }
1982 1982  ]
1983 1983  
1978 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1979 +|deviceTime|Время сообщения терминала
1980 +|serverTime|Время когда сообщение поступило на сервер
1981 +|speed|Скорость
1982 +|altitude|Высота над уровнем моря
1983 +|latitude|Широта
1984 +|longitude|Долгота
1985 +|satellites|Кол-во спутников
1986 +|course|Курс
1987 +|voltage|Бортовое напряжение
1988 +|parameters|Список параметров и их значений
1989 +|photoCount|Количество фото
1990 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1991 +|protocolType|ID типа протокола
1992 +
1984 1984  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1985 1985  
1986 1986  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2114,6 +2114,96 @@
2114 2114   }
2115 2115  ]
2116 2116  
2126 +
2127 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2128 +
2129 +(% class="box infomessage" %)
2130 +(((
2131 +**POST /api/v3/vehicles/moveStop**
2132 +)))
2133 +
2134 +Метод запроса: **POST**
2135 +
2136 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2137 +
2138 +В заголовках запроса: X-Auth: Токен авторизации
2139 +
2140 +
2141 +Тело запроса:
2142 +
2143 +{
2144 + "vehicleIds": [ ], ~/~/ Список ID объектов
2145 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2146 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2147 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2148 +}
2149 +
2150 +Ответ:
2151 +
2152 +[ 
2153 + {
2154 + "vehicleId": 0, ~/~/ ID объекта
2155 + "vehicleName": "string", ~/~/ Имя объекта
2156 + "moves": [ ~/~/ Событие движения
2157 + {
2158 + "mileage": 0, ~/~/ Пробег, км
2159 + "eventId": 0, ~/~/ Идентификатор события
2160 + "eventName": "string", ~/~/ Название события
2161 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2162 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2163 + "duration": 0 ~/~/ Продолжительность события, секунд
2164 + }
2165 + ],
2166 + "stops": [ ~/~/ События стоянок
2167 + {
2168 + "address": "string", ~/~/ Адрес события
2169 + "eventId": 0, ~/~/ Идентификатор события
2170 + "eventName": "string", ~/~/ Название события
2171 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2172 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2173 + "duration": 0 ~/~/ Продолжительность события, секунд
2174 + }
2175 + ]
2176 + }
2177 +]
2178 +
2179 +
2180 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2181 +
2182 +(% class="box infomessage" %)
2183 +(((
2184 +**POST /api/v3/vehicles/getlastdata**
2185 +)))
2186 +
2187 +Метод запроса: **POST**
2188 +
2189 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2190 +
2191 +В заголовках запроса: X-Auth: Токен авторизации
2192 +
2193 +
2194 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2195 +
2196 +Ответ:
2197 + {
2198 + "vehicleId": 0, ~/~/Идентификатор объекта.
2199 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2200 + "vehicleNumber": "string",~/~/Номер объекта.
2201 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2202 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2203 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2204 + "speed": 0,~/~/Скорость объекта.
2205 + "course": 0,~/~/Курс движения [0;360]
2206 + "latitude": 0,~/~/Широта [-90°;90°].
2207 + "longitude": 0,~/~/Долгота [-180°;180°].
2208 + "address": "string",~/~/Адрес.
2209 + "geozones": [ ~/~/Сведения по геозонам.
2210 + {
2211 + "id": 0,
2212 + "name": "string"
2213 + }
2214 +
2215 +
2117 2117  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2118 2118  
2119 2119  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3611,7 +3611,7 @@
3611 3611  **POST /api/v3/vehicles/import/{agentId}**
3612 3612  )))
3613 3613  
3614 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3713 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3615 3615  
3616 3616  В пути указывается **agentId** - id клиента.
3617 3617  
... ... @@ -3623,7 +3623,7 @@
3623 3623  
3624 3624  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3625 3625  |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3626 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3725 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3627 3627  
3628 3628  В теле использовать тип **form-data,** тип значения** file**
3629 3629  
... ... @@ -3790,7 +3790,7 @@
3790 3790  
3791 3791  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3792 3792  
3793 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3892 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3794 3794  
3795 3795  (% class="box infomessage" %)
3796 3796  (((
... ... @@ -3896,6 +3896,444 @@
3896 3896  |driverName|Имя водителя
3897 3897  |driverRfid|Номер Карты-метки
3898 3898  
3998 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3999 +
4000 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4001 +
4002 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4003 +
4004 +(% class="box infomessage" %)
4005 +(((
4006 +POST /api/v3/fuelcards/transactions
4007 +)))
4008 +
4009 +Метод запроса: POST
4010 +
4011 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4012 +\\В заголовках запроса: X-Auth: Токен авторизации
4013 +
4014 +Параметры в теле запроса (JSON):
4015 +
4016 +{
4017 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4018 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4019 + "ids": [ 
4020 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4021 + ],
4022 + "timezone": 0 ~/~/Таймзона
4023 +}
4024 +
4025 +
4026 +Ответ:
4027 + {
4028 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4029 + "driver": "string", ~/~/Водители, привязанные к ТК
4030 + "object": "string", ~/~/Наименование ТС
4031 + "amount": 0, ~/~/Количество топлива
4032 + "amountDut": 0, ~/~/Количество по ДУТ
4033 + "amountDiff": 0, ~/~/Разница, л
4034 + "amountDiffPerc": 0, ~/~/Разница, %
4035 + "summa": 0, ~/~/Стоимость, руб
4036 + "serviceName": "string", ~/~/Тип топлива
4037 + "price": 0, ~/~/Цена за литр, руб
4038 + "cardName": "string", ~/~/Наименование ТК
4039 + "cardNum": "string", ~/~/Номер ТК
4040 + "operator": "string", ~/~/Оператор ТК
4041 + "address": "string" ~/~/Адрес АЗС
4042 + }
4043 +
4044 +
4045 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4046 +
4047 +
4048 +== **Получение полных данных о ретрансляторе** ==
4049 +
4050 +(% class="box infomessage" %)
4051 +(((
4052 +**GET ** **/api/v3/retranslations/{id}**
4053 +)))
4054 +
4055 +Идентификатор запроса: ID
4056 +
4057 +
4058 +Пример ответа:
4059 +
4060 +{  
4061 +"description": "", ~/~/ Определяет описание
4062 +"subscriberId": "", ~/~/ Подписчик
4063 +"protocolType": 0, ~/~/ Тип протокола
4064 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4065 +"address": "string", ~/~/ Адрес события
4066 +"objects": [ ~/~/Объекты для ретрансляции
4067 +{      
4068 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4069 +"name": "", ~/~/ Наименование объекта ретрансляции
4070 +"imei": "", ~/~/ IMEI объекта  
4071 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4072 +}
4073 + ],  
4074 +"id": "", ~/~/ идентификатор пользователя   
4075 +"parentId": "", ~/~/Guid родителя
4076 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4077 +}
4078 +
4079 +
4080 +== **Удаление данных ретранслятора** ==
4081 +
4082 +(% class="box infomessage" %)
4083 +(((
4084 +**DELETE** **/api/v3/retranslations/{id}**
4085 +)))
4086 +
4087 +Параметр запроса: ID
4088 +
4089 +
4090 +== **Создание ретранслятора** ==
4091 +
4092 +(% class="box infomessage" %)
4093 +(((
4094 +**POST ** **/api/v3/retranslations/{id}**
4095 +)))
4096 +
4097 +Запрос:
4098 +
4099 +{  
4100 +"description": "", ~/~/ Описание
4101 +"subscriberId": "", ~/~/ Подписчик
4102 +"protocolType": 0, ~/~/ Тип протокола
4103 +"address": "", ~/~/ Адрес ретрансляции
4104 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4105 +"objects": [ ~/~/Объекты для ретрансляции
4106 +{      
4107 +"id": "", ~/~/ идентификатор пользователя     
4108 +"imei": "", ~/~/IMEI объекта
4109 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4110 +}
4111 + ]
4112 +}
4113 +
4114 +
4115 +Ответ:
4116 +
4117 +{  
4118 +"description": "string", ~/~/ Определяет описание
4119 +"subscriberId": "", ~/~/ идентификатор запроса
4120 +"protocolType": 0, ~/~/ Тип протокола
4121 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4122 +"address": "", ~/~/ Адрес события
4123 +"objects": [ ~/~/Объекты для ретрансляции
4124 +{      
4125 +"id": "", ~/~/ идентификатор пользователя    
4126 +"name": "string", ~/~/ Название уведомления
4127 +"imei": "string", ~/~/IMEI объекта  
4128 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4129 +}
4130 + ],  
4131 +"id": "", ~/~/ идентификатор пользователя  
4132 +"parentId": "", ~/~/ Guid идентификатор родителя
4133 +"deleted": true ~/~/ Признак удаления
4134 +}
4135 +
4136 +
4137 +== **Редактирование ретранслятора** ==
4138 +
4139 +(% class="box infomessage" %)
4140 +(((
4141 +**PUT** **/api/v3/retranslations**
4142 +)))
4143 +
4144 +Пример запроса:
4145 +
4146 +{  
4147 +"id": "", ~/~/ идентификатор пользователя   
4148 +"description": "string", ~/~/ Определяет описание
4149 +"subscriberId": "", ~/~/ идентификатор запроса
4150 +"protocolType": 0, ~/~/ Тип протокола
4151 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4152 +"address": "string", ~/~/ Адрес события
4153 +"objects": ~/~/Объекты для ретрансляции
4154 +[    
4155 +{      
4156 +"id": "",  ~/~/ идентификатор пользователя         
4157 +"imei": "", ~/~/IMEI объекта
4158 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4159 +}
4160 + ]
4161 +}
4162 +
4163 +
4164 +Пример ответа:
4165 +
4166 +{  
4167 +"description": "", ~/~/ Определяет описание
4168 +"subscriberId": "", ~/~/ идентификатор запроса
4169 +"protocolType": 0, ~/~/ Тип протокола
4170 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4171 +"address": "string", ~/~/ Адрес события
4172 +"objects": [ ~/~/Объекты для ретрансляции
4173 +{      
4174 +"id": "", ~/~/ идентификатор пользователя     
4175 +"name": "string", ~/~/ Название уведомления    
4176 +"imei": "", ~/~/IMEI объекта
4177 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4178 +}
4179 + ],
4180 +"id": "", ~/~/ идентификатор пользователя   
4181 +"parentId": "", ~/~/ Guid идентификатор родителя
4182 +"deleted": true ~/~/ Признак удаления
4183 +}
4184 +
4185 +
4186 +== **Получение списка ретранслятора клиента** ==
4187 +
4188 +(% class="box infomessage" %)
4189 +(((
4190 +**POST /api/v3/retranslations/find**
4191 +)))
4192 +
4193 +Пример запроса:
4194 +
4195 +{  
4196 +"id": "", ~/~/ идентификатор пользователя   
4197 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4198 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4199 +}
4200 +
4201 +Ответ:
4202 +
4203 +[ 
4204 +{    
4205 +"description": "", ~/~/ Определяет описание
4206 +"subscriberId": "", ~/~/ идентификатор запроса
4207 +"protocolType": 0, ~/~/ Тип протокола
4208 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4209 +"address": "string", ~/~/ Адрес события
4210 +"id": "", ~/~/ идентификатор пользователя   
4211 +"parentId": "", ~/~/ Guid идентификатор родителя
4212 +"deleted": true ~/~/ Признак удаления
4213 +}
4214 +]
4215 +
4216 +
4217 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4218 +
4219 +== **API для отчета по выгрузке комбайнов** ==
4220 +
4221 +(% class="box infomessage" %)
4222 +(((
4223 +POST **/api/v3/Reports/harvesterUnloading**
4224 +)))
4225 +
4226 +Пример запроса:
4227 +
4228 +{
4229 + "byTime": 0, ~/~/ Объединение событий по времени
4230 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4231 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4232 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4233 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4234 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4235 + 0
4236 + ],
4237 + "from": "", ~/~/ Дата и время начало запроса
4238 + "to": "", ~/~/ Дата и время окончания запроса
4239 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4240 +}
4241 +
4242 +Пример ответа:
4243 +
4244 +[ 
4245 + {
4246 + "harvesterName": "", ~/~/Комбайн, номер
4247 + "harvesterId": 0, ~/~/Комбайн, id
4248 +"harvesterModel": "", ~/~/ Модель комбайна
4249 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4250 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4251 + "events": [ ~/~/Список событий в разрезе комбайна
4252 + {
4253 + "driverId": "", ~/~/Идентификатор водителя
4254 + "driverName": "", ~/~/Водитель комбайна, ФИО
4255 + "RFID": "", ~/~/ идентификатор карты-метки
4256 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4257 + "vehicleId": 0, ~/~/идентификатор объекта
4258 + "vehicleName": "string", ~/~/ Имя объекта
4259 + "modelName": "string", ~/~/ Имя модели объекта
4260 + "nearestVehicles": [ ~/~/Объекты рядом
4261 + {
4262 + "vehicleId": 0, ~/~/идентификатор объекта
4263 + "vehicleName": "string" ~/~/ Имя объекта
4264 + }
4265 + ],
4266 + "fields": [ ~/~/Поля, где происходила выгрузка
4267 + {
4268 + "id": 0, ~/~/ идентификатор пользователя 
4269 + "name": "string" ~/~/ имя пользователя 
4270 + }
4271 + ],
4272 + "event": "string", ~/~/Событие
4273 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4274 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4275 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4276 + "cultureName": "string", ~/~/ название культуры
4277 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4278 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4279 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4280 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4281 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4282 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4283 + "issued": 0, ~/~/Выдано, бункеров
4284 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4285 + "latitude": 0, ~/~/Широта
4286 + "longitude": 0, ~/~/ Долгота
4287 + "litresAway": 0, ~/~/Отдано, л
4288 + "m3Away": 0 ~/~/Отдано, м3
4289 + }
4290 + ]
4291 + }
4292 +]
4293 +
4294 +
4295 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4296 +
4297 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4298 +
4299 +
4300 +(% class="box infomessage" %)
4301 +(((
4302 +GET api/v3/Vehicles/recyclebin/all
4303 +)))
4304 +
4305 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4306 +
4307 +Параметр запроса: {parentId} - идентификатор агента
4308 +
4309 +В заголовках запроса: X-Auth: Токен авторизации
4310 +
4311 +Ответ:
4312 +
4313 +[ 
4314 + {
4315 + "recordTime": "", ~/~/Время записи
4316 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4317 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4318 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4319 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4320 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4321 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4322 + "items": [ ~/~/ 
4323 +nullable: true ~/~/Детали
4324 + {
4325 + "name": "string", ~/~/наименование столбца
4326 + "value": "string" ~/~/содержание столбца
4327 + }
4328 + ]
4329 + },
4330 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4331 + "string"
4332 + ]
4333 + }
4334 +]
4335 +
4336 +
4337 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4338 +
4339 +(% class="box infomessage" %)
4340 +(((
4341 +POST/api/v3/Vehicles/recyclebin/erase
4342 +)))
4343 +
4344 +В заголовках запроса: X-Auth: Токен авторизации
4345 +
4346 +Пример запроса:
4347 +
4348 +[
4349 +0
4350 +]
4351 +
4352 +
4353 +Пример ответа:
4354 +
4355 +[ 
4356 +{
4357 + "recordTime": "", ~/~/Время записи
4358 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4359 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4360 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4361 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4362 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4363 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4364 + "items": [ ~/~/Детали
4365 + {
4366 + "name": "", ~/~/Имя свойства
4367 + "value": "" ~/~/Значение свойства
4368 + }
4369 + ]
4370 + },
4371 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4372 + ""
4373 + ]
4374 + }
4375 +]
4376 +
4377 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4378 +
4379 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4380 +
4381 +(% class="box infomessage" %)
4382 +(((
4383 +POST/api/v3/Vehicles/recyclebin/restore
4384 +)))
4385 +
4386 +В заголовках запроса: X-Auth: Токен авторизации
4387 +
4388 +Параметры в теле запроса (JSON):
4389 +
4390 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4391 +
4392 +В заголовках запроса: X-Auth: Токен авторизации
4393 +
4394 +
4395 +Пример запроса:
4396 +
4397 +(((
4398 +[
4399 +)))
4400 +
4401 +(((
4402 + 0
4403 +)))
4404 +
4405 +(((
4406 +]
4407 +)))
4408 +
4409 +
4410 +Пример ответа:
4411 +
4412 +[
4413 +{
4414 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4415 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4416 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4417 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4418 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4419 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4420 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4421 + "items": [ ~/~/Детали
4422 + {
4423 + "name": "string", ~/~/Имя свойства
4424 + "value": "string" ~/~/Значение свойства
4425 + }
4426 + ]
4427 + },
4428 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4429 + "string"
4430 + ]
4431 + }
4432 +]
4433 +
4434 +
4435 +
3899 3899  (% class="box" lang="en-US" style="text-align: center;" %)
3900 3900  (((
3901 3901  (% 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 г.