Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -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" %) 47 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 48 + "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 59 +(% class="wikigeneratedid" %) 60 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 61 + 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 { ... ... @@ -356,6 +356,21 @@ 356 356 357 357 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 358 358 355 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 356 + 357 +(% class="box warningmessage" %) 358 +((( 359 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 360 +))) 361 + 362 +Метод позволяет изменить статус клиента, указанного в запросе. 363 + 364 +В пути указывается GUID клиента и статус клиента. 365 + 366 +**status **- значение 0 - заблокирован, 1 - активен. 367 + 368 +Ответ: Code 204 369 + 359 359 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 360 360 361 361 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -407,7 +407,6 @@ 407 407 ], 408 408 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 409 409 } 410 - 411 411 { 412 412 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 413 413 "lastName": "string", ... ... @@ -421,12 +421,8 @@ 421 421 422 422 (% style="text-align:left" %) 423 423 (% style="color:#000000; font-weight:normal" %)Ответ: 424 - 425 -(% style="text-align:left" %) 426 -(% style="color:#000000; font-weight:normal" %){ 427 - 428 -(% style="text-align:left" %) 429 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 434 +{ 435 + "id": "" , ~/~/ ID пользователя 430 430 "lastName": "" , ~/~/ Фамилия , 431 431 "firstName": "" , ~/~/ Имя 432 432 "position": "" , ~/~/ Должность ... ... @@ -443,11 +443,9 @@ 443 443 "kind": "" , ~/~/ тип аутентификации 444 444 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 445 445 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 452 +} 446 446 447 -(% style="text-align:left" %) 448 -(% style="color:#000000; font-weight:normal" %)} 449 449 450 - 451 451 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 452 452 453 453 (% class="box infomessage" %) ... ... @@ -467,19 +467,16 @@ 467 467 468 468 (% style="color:#000000" %)Параметры в теле запроса (JSON): 469 469 470 -(% style="color:#000000" %){ 471 - 474 +(% style="color:#000000" %){(%%) 472 472 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 473 473 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 474 474 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 475 475 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 476 - 477 477 (% style="color:#000000" %)} 478 478 479 479 (% style="color:#000000" %)Ответ: 480 480 481 481 (% style="color:#000000" %){ (%%) 482 - 483 483 "id": "" , ~/~/ идентификатор пользователя 484 484 "lastName": "" , ~/~/ фамилия 485 485 "firstName": "" , ~/~/ имя ... ... @@ -493,7 +493,6 @@ 493 493 "sessionDuration":"", ~/~/ длительность сессии в минутах 494 494 "status": "1", ~/~/ статус пользователя 495 495 "lastLogged": "", ~/~/ дата/время последней авторизации 496 - 497 497 (% style="color:#000000" %)} 498 498 499 499 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -567,10 +567,8 @@ 567 567 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 568 568 569 569 (% lang="en-US" style="text-align:left" %) 570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 - 572 -(% lang="en-US" style="text-align:left" %) 573 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 570 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 + "id": "" , ~/~/ ID пользователя 574 574 "lastName": "" , ~/~/ фамилия 575 575 "firstName": "" , ~/~/ имя 576 576 "position": "" , ~/~/ должность ... ... @@ -592,9 +592,7 @@ 592 592 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 593 593 }, 594 594 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 595 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 596 - 597 -(% lang="en-US" style="text-align:left" %) 593 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 598 598 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 599 599 600 600 (% lang="en-US" style="text-align:left" %) ... ... @@ -601,10 +601,8 @@ 601 601 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 602 602 603 603 (% lang="en-US" style="text-align:left" %) 604 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 605 - 606 -(% lang="en-US" style="text-align:left" %) 607 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 600 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 601 + "id": "" , ~/~/ идентификатор пользователя 608 608 "lastName": "" , ~/~/ фамилия 609 609 "firstName": "" , ~/~/ имя 610 610 "position": "" , ~/~/ должность ... ... @@ -625,10 +625,8 @@ 625 625 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 626 626 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 627 627 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 622 +} 628 628 629 -(% lang="en-US" style="text-align:left" %) 630 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 631 - 632 632 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 633 633 634 634 (% class="box warningmessage" %) ... ... @@ -648,12 +648,10 @@ 648 648 649 649 (% style="color:#000000" %)Параметры в теле запроса (JSON): 650 650 651 -(% style="color:#000000" %){ 652 - 643 +(% style="color:#000000" %){(%%) 653 653 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 654 654 "description": "" , ~/~/ описание 655 655 "data": "" , ~/~/ данные, связанные со сменой статуса 656 - 657 657 (% style="color:#000000" %)} 658 658 659 659 (% style="text-align:left" %) ... ... @@ -675,7 +675,7 @@ 675 675 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 676 676 677 677 [ 678 - 668 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 679 679 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 680 680 ] 681 681 ... ... @@ -1017,19 +1017,15 @@ 1017 1017 "deviceTypeName": "", ~/~/ Название типа устройства 1018 1018 "sim1": "", ~/~/ Номер SIM1 1019 1019 "sim2": "", ~/~/ Номер SIM2 1020 - 1021 1021 "parentId": "", ~/~/ ID клиента-родителя 1022 1022 "parentName": "", ~/~/ Наименование клиента-родителя 1023 1023 "modelId": "", ~/~/ ID модели объекта 1024 1024 "modelName": "", ~/~/ Имя модели объекта 1025 - 1026 1026 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1027 1027 "unitName": "string", ~/~/ Наименование подразделения 1028 1028 "status": 0, ~/~/ Статус объекта 1029 - 1030 1030 "createdAt": "", ~/~/ Дата создания объекта 1031 1031 }, 1032 - 1033 1033 "customFields": [ ~/~/ Произвольные поля 1034 1034 { 1035 1035 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1052,8 +1052,7 @@ 1052 1052 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1053 1053 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1054 1054 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1055 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1056 - 1041 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1057 1057 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1058 1058 "mileageCoeff": 0, ~/~/ коэффициент пробега 1059 1059 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1083,7 +1083,6 @@ 1083 1083 "retries": 0 ~/~/ Количество попыток 1084 1084 } 1085 1085 ], 1086 - 1087 1087 "sensors": [ ~/~/ Датчики 1088 1088 { 1089 1089 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1124,31 +1124,19 @@ 1124 1124 }, 1125 1125 1126 1126 ~/~/ Характерные для произвольного: 1127 - 1128 1128 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1129 - 1130 1130 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1131 - 1132 1132 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1133 - 1134 1134 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1135 - 1136 1136 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1137 - 1138 1138 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1139 - 1140 1140 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1141 - 1142 1142 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1143 - 1144 1144 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1145 - 1146 1146 ~/~/ "ValueOn": "Вкл.", 1147 - 1148 1148 ~/~/ "ValueOff": "Выкл." 1149 1149 "summaryMaxValue": 0 ~/~/ Макс. значение 1150 1150 } 1151 - 1152 1152 "drivers": [ ~/~/ Водители 1153 1153 { 1154 1154 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1157,7 +1157,6 @@ 1157 1157 "isDefault": true ~/~/ По умолчанию 1158 1158 } 1159 1159 ], 1160 - 1161 1161 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1162 1162 { 1163 1163 "id": "", ~/~/ ID задания ... ... @@ -1174,8 +1174,7 @@ 1174 1174 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1175 1175 } 1176 1176 ], 1177 - 1178 - "statusHistory": [ ~/~/ История статусов 1148 +"statusHistory": [ ~/~/ История статусов 1179 1179 { 1180 1180 "status": 0, 1181 1181 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1183,7 +1183,6 @@ 1183 1183 "additionalInfo": "string" 1184 1184 } 1185 1185 ] 1186 - 1187 1187 } 1188 1188 ))) 1189 1189 ... ... @@ -1193,6 +1193,56 @@ 1193 1193 (% style="text-align:left" %) 1194 1194 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1195 1195 1165 + 1166 +== **Получить ответ на отправленную на ТС команду** == 1167 + 1168 +(% class="box infomessage" %) 1169 +((( 1170 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1171 +))) 1172 + 1173 +Идентификатор команды: cmdid 1174 + 1175 +Запрос от терминала на ответ команды 1176 + 1177 +Пример ответ от терминала: 1178 + 1179 +ID= "" ~/~/ идентификатор произвольного поля 1180 +Soft="" ~/~/ версия софта 1181 +GPS=4 ~/~/ тип трекера 1182 +Time=11:05:43 28.06.24 ~/~/ время запроса 1183 +Lat=45.056221 ~/~/ широта 1184 +Lon=39.035938 ~/~/ долгота 1185 +Speed=0.0 ~/~/ скорость 1186 +Course=181.4 ~/~/направление 1187 + 1188 +((( 1189 +== **Список отправленных объекту команд с ответами** == 1190 + 1191 +(% class="box infomessage" %) 1192 +((( 1193 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1194 +))) 1195 + 1196 +Идентификатор ТС: vehicleId 1197 + 1198 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1199 + 1200 +Пример ответа терминала 1201 + 1202 +[ 1203 +{ 1204 +"id": "", ~/~/ идентификатор пользователя 1205 +"commandText": "", ~/~/Текст команды. 1206 +"templateId": "", ~/~/Идентификатор шаблона 1207 +"updated": "", ~/~/ Время отправки 1208 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1209 +"answer": "", ~/~/ Ответ терминала. 1210 +"status": "" ~/~/ Статус отправки 1211 +} 1212 +] 1213 +))) 1214 + 1196 1196 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1197 1197 1198 1198 (% class="box successmessage" %) ... ... @@ -1210,8 +1210,7 @@ 1210 1210 1211 1211 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1212 1212 1213 -(% style="color:#000000" %){ 1214 - 1232 +(% style="color:#000000" %){(%%) 1215 1215 "parentId": "" , ~/~/ ID клиента 1216 1216 "name": "" , ~/~/ имя ТС 1217 1217 "imei": "" , ~/~/ IMEI ... ... @@ -1232,7 +1232,6 @@ 1232 1232 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1233 1233 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1234 1234 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1235 - 1236 1236 "mileageCalcMethod": 0, 1237 1237 "mileageCoeff": 0, 1238 1238 "locationByCellId": true, ... ... @@ -1265,7 +1265,6 @@ 1265 1265 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1266 1266 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1267 1267 } 1268 - 1269 1269 "drivers": [ ~/~/ Водители 1270 1270 { 1271 1271 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1280,8 +1280,7 @@ 1280 1280 "retries": 0 1281 1281 } 1282 1282 ], 1283 - 1284 - "sensors": [ ~/~/ Датчики 1299 +"sensors": [ ~/~/ Датчики 1285 1285 { 1286 1286 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1287 1287 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1319,29 +1319,17 @@ 1319 1319 "additionalProp2": "string", 1320 1320 "additionalProp3": "string" 1321 1321 }, 1322 - 1323 1323 ~/~/ Характерные для произвольного: 1324 - 1325 1325 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1326 - 1327 1327 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1328 - 1329 1329 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1330 - 1331 1331 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1332 - 1333 1333 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1334 - 1335 1335 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1336 - 1337 1337 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1338 - 1339 1339 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1340 - 1341 1341 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1342 - 1343 1343 ~/~/ "ValueOn": "Вкл.", 1344 - 1345 1345 ~/~/ "ValueOff": "Выкл." 1346 1346 "summaryMaxValue": 0 ~/~/ Макс. значение 1347 1347 } ... ... @@ -1360,8 +1360,7 @@ 1360 1360 1361 1361 (% style="color:#000000" %)Ответ: 1362 1362 1363 -(% style="color:#000000" %){ 1364 - 1366 +(% style="color:#000000" %){(%%) 1365 1365 "vehicleId": "", ~/~/ID ТС 1366 1366 "parentId": "", ~/~/Guid владельца ТС 1367 1367 "name": "", ~/~/Имя объекта ... ... @@ -1399,8 +1399,6 @@ 1399 1399 "kind": "", ~/~/ Вид периодичности по времени 1400 1400 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1401 1401 } 1402 - 1403 -(% style="text-align:left" %) 1404 1404 (% style="color:#000000" %)} 1405 1405 1406 1406 **Валидация:** ... ... @@ -1415,7 +1415,7 @@ 1415 1415 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1416 1416 ))) 1417 1417 1418 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1418 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1419 1419 1420 1420 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1421 1421 ... ... @@ -1459,8 +1459,7 @@ 1459 1459 (% style="color:#000000" %)Ответ: 1460 1460 1461 1461 (% style="color:#000000" %){ 1462 - 1463 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1462 + "vehicleId": "" ~/~/ идентификатор объекта 1464 1464 "name": "" ~/~/ наименование объекта 1465 1465 "imei": "" ~/~/ IMEI объекта 1466 1466 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1519,13 +1519,11 @@ 1519 1519 "data": "", ~/~/ Данные 1520 1520 "overwrite": false, ~/~/ Флаг перезаписи 1521 1521 "stage": "", ~/~/ Состояние, может быть null 1522 - 1523 1523 (% style="color:#000000" %)} 1524 1524 1525 1525 (% style="color:#000000" %)Ответ: 1526 1526 1527 -(% style="color:#000000" %){ 1528 - 1525 +(% style="color:#000000" %){(%%) 1529 1529 "status": "", ~/~/ значение статуса 1530 1530 "date": "", ~/~/ Дата смены статуса 1531 1531 "description": "", ~/~/ Описание ... ... @@ -1532,10 +1532,25 @@ 1532 1532 "data": "", ~/~/ Данные 1533 1533 "overwrite": false, ~/~/ Флаг перезаписи 1534 1534 "stage": "", ~/~/ Состояние 1535 - 1536 -(% style="text-align:left" %) 1537 1537 (% style="color:#000000" %) } 1538 1538 1534 +== **Отправить команду на терминал** == 1535 + 1536 +(% class="box successmessage" %) 1537 +((( 1538 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1539 +))) 1540 + 1541 +Команда для отправки на тс. 1542 + 1543 +{ 1544 +"id": "", ~/~/идентификатор произвольного поля 1545 +"command": "", ~/~/ Текст команды 1546 +"retries": "", ~/~/ Количество попыток 1547 +"idTemplate": "" ~/~/ ID шаблона команды 1548 +} 1549 + 1550 + 1539 1539 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1540 1540 1541 1541 (% class="box warningmessage" %) ... ... @@ -1623,8 +1623,7 @@ 1623 1623 "retries": 0 1624 1624 } 1625 1625 ], 1626 - 1627 - "sensors": [ ~/~/ Датчики 1638 +"sensors": [ ~/~/ Датчики 1628 1628 { 1629 1629 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1630 1630 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1662,29 +1662,17 @@ 1662 1662 "additionalProp2": "string", 1663 1663 "additionalProp3": "string" 1664 1664 }, 1665 - 1666 1666 ~/~/ Характерные для произвольного: 1667 - 1668 1668 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1669 - 1670 1670 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1671 - 1672 1672 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1673 - 1674 1674 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1675 - 1676 1676 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1677 - 1678 1678 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1679 - 1680 1680 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1681 - 1682 1682 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1683 - 1684 1684 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1685 - 1686 1686 ~/~/ "ValueOn": "Вкл.", 1687 - 1688 1688 ~/~/ "ValueOff": "Выкл." 1689 1689 "summaryMaxValue": 0 ~/~/ Макс. значение 1690 1690 } ... ... @@ -1704,9 +1704,7 @@ 1704 1704 (% style="color:#000000" %)Ответ: 1705 1705 1706 1706 (% lang="en-US" style="text-align:left" %) 1707 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1708 - 1709 -(% lang="en-US" style="text-align:left" %) 1706 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1710 1710 "vehicleId": "", ~/~/ ID ТС 1711 1711 "parentId": "", ~/~/ ID клиента 1712 1712 "name": "", ~/~/ имя ТС ... ... @@ -1747,8 +1747,6 @@ 1747 1747 "kind": "", ~/~/ Вид периодичности по времени 1748 1748 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1749 1749 } 1750 - 1751 -(% lang="en-US" style="text-align:left" %) 1752 1752 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1753 1753 1754 1754 **Валидация:** ... ... @@ -1789,18 +1789,15 @@ 1789 1789 1790 1790 (% style="color:#000000" %)Метод запроса: **GET** 1791 1791 1792 -(% 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]]1787 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1793 1793 1794 1794 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1795 1795 1796 1796 (% style="color:#000000" %)Ответ: 1797 1797 1798 -(% style="color:#000000" %){ 1799 - 1793 +(% style="color:#000000" %){(%%) 1800 1800 "deviceTypeId" : "", ~/~/ ID типа устройства 1801 1801 "deviceTypeName" : "" ~/~/ Название типа устройства 1802 - 1803 -(% style="text-align:left" %) 1804 1804 (% style="color:#000000" %)} 1805 1805 1806 1806 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1822,13 +1822,10 @@ 1822 1822 1823 1823 (% style="color:#000000" %)Ответ: 1824 1824 1825 -(% style="color:#000000" %){ 1826 - 1817 +(% style="color:#000000" %){(%%) 1827 1827 "id": "", ~/~/ ID типа датчика 1828 1828 "name": "", ~/~/ Название 1829 1829 "description": "", ~/~/ Описание 1830 - 1831 -(% style="text-align:left" %) 1832 1832 (% style="color:#000000" %)} 1833 1833 1834 1834 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1872,6 +1872,56 @@ 1872 1872 } 1873 1873 ] 1874 1874 1864 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1865 + 1866 +(% class="box infomessage" style="text-align: left;" %) 1867 +((( 1868 +**POST /api/v3/terminalMessages/mapping** 1869 +))) 1870 + 1871 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1872 + 1873 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1874 + 1875 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1876 + 1877 +{ 1878 + "protocolType": 0, 1879 + "params": ["string"] 1880 +} 1881 + 1882 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1883 +|protocolType|ID типа протокола 1884 +|params|((( 1885 +Массив наименований параметров в сообщении 1886 +))) 1887 + 1888 +Ответ: 1889 + 1890 +{ 1891 + "protocolType": 0, 1892 + "mapping": { 1893 + "additionalProp1": { 1894 + "inputType": 0, 1895 + "inputNumber": 0 1896 + }, 1897 + "additionalProp2": { 1898 + "inputType": 0, 1899 + "inputNumber": 0 1900 + } 1901 + } 1902 +} 1903 + 1904 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1905 +|protocolType|Тип протокола 1906 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1907 +|inputNumber|((( 1908 +Номер входа 1909 +))) 1910 + 1911 +(% class="wikigeneratedid" %) 1912 +Перечень 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/]] 1913 + 1875 1875 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1876 1876 1877 1877 (% class="box infomessage" %) ... ... @@ -1896,6 +1896,11 @@ 1896 1896 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1897 1897 } 1898 1898 1938 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1939 +|vehicleId|ID объекта 1940 +|from|Дата и время начала периода запроса 1941 +|to|Дата и время окончания периода запроса 1942 + 1899 1899 Ответ: 1900 1900 1901 1901 [ ... ... @@ -1902,25 +1902,43 @@ 1902 1902 { 1903 1903 "messages": [ 1904 1904 { 1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1907 - "speed": 0, ~/~/ Скорость, км/ч 1908 - "altitude": 0, ~/~/ Высота, м 1909 - "latitude": 0, ~/~/ Широта [-90°;90°] 1910 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1911 - "satellites": 0, ~/~/ Кол-во спутников 1912 - "voltage": 0, ~/~/ Напряжение 1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1949 + "deviceTime": "2023-11-29T07:40:44.052Z", 1950 + "serverTime": "2023-11-29T07:40:44.052Z", 1951 + "speed": 0, 1952 + "altitude": 0, 1953 + "latitude": 0, 1954 + "longitude": 0, 1955 + "satellites": 0, 1956 + "course": 0, 1957 + "voltage": 0, 1958 + "parameters": { 1914 1914 "additionalProp1": "string", 1915 1915 "additionalProp2": "string", 1916 1916 "additionalProp3": "string" 1917 1917 }, 1918 - "photoCount": 0 ~/~/ Кол-во фото 1963 + "photoCount": 0, 1964 + "lbsCorrectedCoords": true, 1965 + "protocolType": 0 1919 1919 } 1920 1920 ] 1921 1921 } 1922 1922 ] 1923 1923 1971 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1972 +|deviceTime|Время сообщения терминала 1973 +|serverTime|Время когда сообщение поступило на сервер 1974 +|speed|Скорость 1975 +|altitude|Высота над уровнем моря 1976 +|latitude|Широта 1977 +|longitude|Долгота 1978 +|satellites|Кол-во спутников 1979 +|course|Курс 1980 +|voltage|Бортовое напряжение 1981 +|parameters|Список параметров и их значений 1982 +|photoCount|Количество фото 1983 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 1984 +|protocolType|ID типа протокола 1985 + 1924 1924 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1925 1925 1926 1926 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2054,6 +2054,96 @@ 2054 2054 } 2055 2055 ] 2056 2056 2119 + 2120 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2121 + 2122 +(% class="box infomessage" %) 2123 +((( 2124 +**POST /api/v3/vehicles/moveStop** 2125 +))) 2126 + 2127 +Метод запроса: **POST** 2128 + 2129 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2130 + 2131 +В заголовках запроса: X-Auth: Токен авторизации 2132 + 2133 + 2134 +Тело запроса: 2135 + 2136 +{ 2137 + "vehicleIds": [ ], ~/~/ Список ID объектов 2138 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2139 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2140 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2141 +} 2142 + 2143 +Ответ: 2144 + 2145 +[ 2146 + { 2147 + "vehicleId": 0, ~/~/ ID объекта 2148 + "vehicleName": "string", ~/~/ Имя объекта 2149 + "moves": [ ~/~/ Событие движения 2150 + { 2151 + "mileage": 0, ~/~/ Пробег, км 2152 + "eventId": 0, ~/~/ Идентификатор события 2153 + "eventName": "string", ~/~/ Название события 2154 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2155 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2156 + "duration": 0 ~/~/ Продолжительность события, секунд 2157 + } 2158 + ], 2159 + "stops": [ ~/~/ События стоянок 2160 + { 2161 + "address": "string", ~/~/ Адрес события 2162 + "eventId": 0, ~/~/ Идентификатор события 2163 + "eventName": "string", ~/~/ Название события 2164 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2165 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2166 + "duration": 0 ~/~/ Продолжительность события, секунд 2167 + } 2168 + ] 2169 + } 2170 +] 2171 + 2172 + 2173 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2174 + 2175 +(% class="box infomessage" %) 2176 +((( 2177 +**POST /api/v3/vehicles/getlastdata** 2178 +))) 2179 + 2180 +Метод запроса: **POST** 2181 + 2182 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2183 + 2184 +В заголовках запроса: X-Auth: Токен авторизации 2185 + 2186 + 2187 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2188 + 2189 +Ответ: 2190 + { 2191 + "vehicleId": 0, ~/~/Идентификатор объекта. 2192 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2193 + "vehicleNumber": "string",~/~/Номер объекта. 2194 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2195 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2196 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2197 + "speed": 0,~/~/Скорость объекта. 2198 + "course": 0,~/~/Курс движения [0;360] 2199 + "latitude": 0,~/~/Широта [-90°;90°]. 2200 + "longitude": 0,~/~/Долгота [-180°;180°]. 2201 + "address": "string",~/~/Адрес. 2202 + "geozones": [ ~/~/Сведения по геозонам. 2203 + { 2204 + "id": 0, 2205 + "name": "string" 2206 + } 2207 + 2208 + 2057 2057 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2058 2058 2059 2059 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -3586,11 +3586,11 @@ 3586 3586 |name|Имя созданного объекта 3587 3587 |errors|Ошибки и их описание 3588 3588 3589 -(% style="color:#000000; font-size:16px" %)**Импорт об ъектов**3741 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3590 3590 3591 3591 (% class="box infomessage" %) 3592 3592 ((( 3593 -**POST /api/v3/vehicles/import/history/{vehicleId}** 3745 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3594 3594 ))) 3595 3595 3596 3596 (% class="wikigeneratedid" %) ... ... @@ -3730,7 +3730,7 @@ 3730 3730 3731 3731 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3732 3732 3733 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==3885 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3734 3734 3735 3735 (% class="box infomessage" %) 3736 3736 ((( ... ... @@ -3836,6 +3836,444 @@ 3836 3836 |driverName|Имя водителя 3837 3837 |driverRfid|Номер Карты-метки 3838 3838 3991 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3992 + 3993 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 3994 + 3995 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 3996 + 3997 +(% class="box infomessage" %) 3998 +((( 3999 +POST /api/v3/fuelcards/transactions 4000 +))) 4001 + 4002 +Метод запроса: POST 4003 + 4004 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4005 +\\В заголовках запроса: X-Auth: Токен авторизации 4006 + 4007 +Параметры в теле запроса (JSON): 4008 + 4009 +{ 4010 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4011 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4012 + "ids": [ 4013 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4014 + ], 4015 + "timezone": 0 ~/~/Таймзона 4016 +} 4017 + 4018 + 4019 +Ответ: 4020 + { 4021 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4022 + "driver": "string", ~/~/Водители, привязанные к ТК 4023 + "object": "string", ~/~/Наименование ТС 4024 + "amount": 0, ~/~/Количество топлива 4025 + "amountDut": 0, ~/~/Количество по ДУТ 4026 + "amountDiff": 0, ~/~/Разница, л 4027 + "amountDiffPerc": 0, ~/~/Разница, % 4028 + "summa": 0, ~/~/Стоимость, руб 4029 + "serviceName": "string", ~/~/Тип топлива 4030 + "price": 0, ~/~/Цена за литр, руб 4031 + "cardName": "string", ~/~/Наименование ТК 4032 + "cardNum": "string", ~/~/Номер ТК 4033 + "operator": "string", ~/~/Оператор ТК 4034 + "address": "string" ~/~/Адрес АЗС 4035 + } 4036 + 4037 + 4038 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4039 + 4040 + 4041 +== **Получение полных данных о ретрансляторе** == 4042 + 4043 +(% class="box infomessage" %) 4044 +((( 4045 +**GET ** **/api/v3/retranslations/{id}** 4046 +))) 4047 + 4048 +Идентификатор запроса: ID 4049 + 4050 + 4051 +Пример ответа: 4052 + 4053 +{ 4054 +"description": "", ~/~/ Определяет описание 4055 +"subscriberId": "", ~/~/ Подписчик 4056 +"protocolType": 0, ~/~/ Тип протокола 4057 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4058 +"address": "string", ~/~/ Адрес события 4059 +"objects": [ ~/~/Объекты для ретрансляции 4060 +{ 4061 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4062 +"name": "", ~/~/ Наименование объекта ретрансляции 4063 +"imei": "", ~/~/ IMEI объекта 4064 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4065 +} 4066 + ], 4067 +"id": "", ~/~/ идентификатор пользователя 4068 +"parentId": "", ~/~/Guid родителя 4069 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4070 +} 4071 + 4072 + 4073 +== **Удаление данных ретранслятора** == 4074 + 4075 +(% class="box infomessage" %) 4076 +((( 4077 +**DELETE** **/api/v3/retranslations/{id}** 4078 +))) 4079 + 4080 +Параметр запроса: ID 4081 + 4082 + 4083 +== **Создание ретранслятора** == 4084 + 4085 +(% class="box infomessage" %) 4086 +((( 4087 +**POST ** **/api/v3/retranslations/{id}** 4088 +))) 4089 + 4090 +Запрос: 4091 + 4092 +{ 4093 +"description": "", ~/~/ Описание 4094 +"subscriberId": "", ~/~/ Подписчик 4095 +"protocolType": 0, ~/~/ Тип протокола 4096 +"address": "", ~/~/ Адрес ретрансляции 4097 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4098 +"objects": [ ~/~/Объекты для ретрансляции 4099 +{ 4100 +"id": "", ~/~/ идентификатор пользователя 4101 +"imei": "", ~/~/IMEI объекта 4102 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4103 +} 4104 + ] 4105 +} 4106 + 4107 + 4108 +Ответ: 4109 + 4110 +{ 4111 +"description": "string", ~/~/ Определяет описание 4112 +"subscriberId": "", ~/~/ идентификатор запроса 4113 +"protocolType": 0, ~/~/ Тип протокола 4114 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4115 +"address": "", ~/~/ Адрес события 4116 +"objects": [ ~/~/Объекты для ретрансляции 4117 +{ 4118 +"id": "", ~/~/ идентификатор пользователя 4119 +"name": "string", ~/~/ Название уведомления 4120 +"imei": "string", ~/~/IMEI объекта 4121 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4122 +} 4123 + ], 4124 +"id": "", ~/~/ идентификатор пользователя 4125 +"parentId": "", ~/~/ Guid идентификатор родителя 4126 +"deleted": true ~/~/ Признак удаления 4127 +} 4128 + 4129 + 4130 +== **Редактирование ретранслятора** == 4131 + 4132 +(% class="box infomessage" %) 4133 +((( 4134 +**PUT** **/api/v3/retranslations** 4135 +))) 4136 + 4137 +Пример запроса: 4138 + 4139 +{ 4140 +"id": "", ~/~/ идентификатор пользователя 4141 +"description": "string", ~/~/ Определяет описание 4142 +"subscriberId": "", ~/~/ идентификатор запроса 4143 +"protocolType": 0, ~/~/ Тип протокола 4144 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4145 +"address": "string", ~/~/ Адрес события 4146 +"objects": ~/~/Объекты для ретрансляции 4147 +[ 4148 +{ 4149 +"id": "", ~/~/ идентификатор пользователя 4150 +"imei": "", ~/~/IMEI объекта 4151 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4152 +} 4153 + ] 4154 +} 4155 + 4156 + 4157 +Пример ответа: 4158 + 4159 +{ 4160 +"description": "", ~/~/ Определяет описание 4161 +"subscriberId": "", ~/~/ идентификатор запроса 4162 +"protocolType": 0, ~/~/ Тип протокола 4163 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4164 +"address": "string", ~/~/ Адрес события 4165 +"objects": [ ~/~/Объекты для ретрансляции 4166 +{ 4167 +"id": "", ~/~/ идентификатор пользователя 4168 +"name": "string", ~/~/ Название уведомления 4169 +"imei": "", ~/~/IMEI объекта 4170 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4171 +} 4172 + ], 4173 +"id": "", ~/~/ идентификатор пользователя 4174 +"parentId": "", ~/~/ Guid идентификатор родителя 4175 +"deleted": true ~/~/ Признак удаления 4176 +} 4177 + 4178 + 4179 +== **Получение списка ретранслятора клиента** == 4180 + 4181 +(% class="box infomessage" %) 4182 +((( 4183 +**POST /api/v3/retranslations/find** 4184 +))) 4185 + 4186 +Пример запроса: 4187 + 4188 +{ 4189 +"id": "", ~/~/ идентификатор пользователя 4190 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4191 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4192 +} 4193 + 4194 +Ответ: 4195 + 4196 +[ 4197 +{ 4198 +"description": "", ~/~/ Определяет описание 4199 +"subscriberId": "", ~/~/ идентификатор запроса 4200 +"protocolType": 0, ~/~/ Тип протокола 4201 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4202 +"address": "string", ~/~/ Адрес события 4203 +"id": "", ~/~/ идентификатор пользователя 4204 +"parentId": "", ~/~/ Guid идентификатор родителя 4205 +"deleted": true ~/~/ Признак удаления 4206 +} 4207 +] 4208 + 4209 + 4210 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4211 + 4212 +== **API для отчета по выгрузке комбайнов** == 4213 + 4214 +(% class="box infomessage" %) 4215 +((( 4216 +POST **/api/v3/Reports/harvesterUnloading** 4217 +))) 4218 + 4219 +Пример запроса: 4220 + 4221 +{ 4222 + "byTime": 0, ~/~/ Объединение событий по времени 4223 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4224 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4225 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4226 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4227 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4228 + 0 4229 + ], 4230 + "from": "", ~/~/ Дата и время начало запроса 4231 + "to": "", ~/~/ Дата и время окончания запроса 4232 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4233 +} 4234 + 4235 +Пример ответа: 4236 + 4237 +[ 4238 + { 4239 + "harvesterName": "", ~/~/Комбайн, номер 4240 + "harvesterId": 0, ~/~/Комбайн, id 4241 +"harvesterModel": "", ~/~/ Модель комбайна 4242 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4243 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4244 + "events": [ ~/~/Список событий в разрезе комбайна 4245 + { 4246 + "driverId": "", ~/~/Идентификатор водителя 4247 + "driverName": "", ~/~/Водитель комбайна, ФИО 4248 + "RFID": "", ~/~/ идентификатор карты-метки 4249 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4250 + "vehicleId": 0, ~/~/идентификатор объекта 4251 + "vehicleName": "string", ~/~/ Имя объекта 4252 + "modelName": "string", ~/~/ Имя модели объекта 4253 + "nearestVehicles": [ ~/~/Объекты рядом 4254 + { 4255 + "vehicleId": 0, ~/~/идентификатор объекта 4256 + "vehicleName": "string" ~/~/ Имя объекта 4257 + } 4258 + ], 4259 + "fields": [ ~/~/Поля, где происходила выгрузка 4260 + { 4261 + "id": 0, ~/~/ идентификатор пользователя 4262 + "name": "string" ~/~/ имя пользователя 4263 + } 4264 + ], 4265 + "event": "string", ~/~/Событие 4266 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4267 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4268 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4269 + "cultureName": "string", ~/~/ название культуры 4270 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4271 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4272 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4273 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4274 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4275 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4276 + "issued": 0, ~/~/Выдано, бункеров 4277 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4278 + "latitude": 0, ~/~/Широта 4279 + "longitude": 0, ~/~/ Долгота 4280 + "litresAway": 0, ~/~/Отдано, л 4281 + "m3Away": 0 ~/~/Отдано, м3 4282 + } 4283 + ] 4284 + } 4285 +] 4286 + 4287 + 4288 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4289 + 4290 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4291 + 4292 + 4293 +(% class="box infomessage" %) 4294 +((( 4295 +GET api/v3/Vehicles/recyclebin/all 4296 +))) 4297 + 4298 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4299 + 4300 +Параметр запроса: {parentId} - идентификатор агента 4301 + 4302 +В заголовках запроса: X-Auth: Токен авторизации 4303 + 4304 +Ответ: 4305 + 4306 +[ 4307 + { 4308 + "recordTime": "", ~/~/Время записи 4309 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4310 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4311 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4312 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4313 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4314 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4315 + "items": [ ~/~/ 4316 +nullable: true ~/~/Детали 4317 + { 4318 + "name": "string", ~/~/наименование столбца 4319 + "value": "string" ~/~/содержание столбца 4320 + } 4321 + ] 4322 + }, 4323 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4324 + "string" 4325 + ] 4326 + } 4327 +] 4328 + 4329 + 4330 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4331 + 4332 +(% class="box infomessage" %) 4333 +((( 4334 +POST/api/v3/Vehicles/recyclebin/erase 4335 +))) 4336 + 4337 +В заголовках запроса: X-Auth: Токен авторизации 4338 + 4339 +Пример запроса: 4340 + 4341 +[ 4342 +0 4343 +] 4344 + 4345 + 4346 +Пример ответа: 4347 + 4348 +[ 4349 +{ 4350 + "recordTime": "", ~/~/Время записи 4351 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4352 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4353 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4354 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4355 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4356 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4357 + "items": [ ~/~/Детали 4358 + { 4359 + "name": "", ~/~/Имя свойства 4360 + "value": "" ~/~/Значение свойства 4361 + } 4362 + ] 4363 + }, 4364 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4365 + "" 4366 + ] 4367 + } 4368 +] 4369 + 4370 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4371 + 4372 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4373 + 4374 +(% class="box infomessage" %) 4375 +((( 4376 +POST/api/v3/Vehicles/recyclebin/restore 4377 +))) 4378 + 4379 +В заголовках запроса: X-Auth: Токен авторизации 4380 + 4381 +Параметры в теле запроса (JSON): 4382 + 4383 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4384 + 4385 +В заголовках запроса: X-Auth: Токен авторизации 4386 + 4387 + 4388 +Пример запроса: 4389 + 4390 +((( 4391 +[ 4392 +))) 4393 + 4394 +((( 4395 + 0 4396 +))) 4397 + 4398 +((( 4399 +] 4400 +))) 4401 + 4402 + 4403 +Пример ответа: 4404 + 4405 +[ 4406 +{ 4407 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4408 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4409 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4410 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4411 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4412 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4413 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4414 + "items": [ ~/~/Детали 4415 + { 4416 + "name": "string", ~/~/Имя свойства 4417 + "value": "string" ~/~/Значение свойства 4418 + } 4419 + ] 4420 + }, 4421 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4422 + "string" 4423 + ] 4424 + } 4425 +] 4426 + 4427 + 4428 + 3839 3839 (% class="box" lang="en-US" style="text-align: center;" %) 3840 3840 ((( 3841 3841 (% 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]] **