Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. SupportZhuchkov1 +XWiki.Gadmin - Content
-
... ... @@ -14,20 +14,11 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При **редактировании** любойзаписи (пользователь, объект и т.д)необходимо передавать все параметры записив теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 - 20 -(% style="color:#000000; font-size:16px" %)**Рекомендации** 21 - 22 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 23 - 24 24 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 25 25 26 -(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 27 -((( 28 -(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 29 -(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 30 -))) 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 31 31 32 32 (% class="box successmessage" %) 33 33 ((( ... ... @@ -53,8 +53,12 @@ 53 53 54 54 (% lang="en-US" %) 55 55 (% style="color:#000000" %){ 56 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 57 - "User": "testuser" , ~/~/ имя пользователя(%%) 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" %) 58 58 } 59 59 60 60 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. ... ... @@ -234,6 +234,7 @@ 234 234 "bankKS": "string" ~/~/ корр. счёт 235 235 } 236 236 232 + 237 237 Ответ: 238 238 239 239 { ... ... @@ -427,6 +427,7 @@ 427 427 ], 428 428 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 429 429 } 426 + 430 430 { 431 431 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 432 432 "lastName": "string", ... ... @@ -440,8 +440,12 @@ 440 440 441 441 (% style="text-align:left" %) 442 442 (% style="color:#000000; font-weight:normal" %)Ответ: 443 -{ 444 - "id": "" , ~/~/ ID пользователя 440 + 441 +(% style="text-align:left" %) 442 +(% style="color:#000000; font-weight:normal" %){ 443 + 444 +(% style="text-align:left" %) 445 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 445 445 "lastName": "" , ~/~/ Фамилия , 446 446 "firstName": "" , ~/~/ Имя 447 447 "position": "" , ~/~/ Должность ... ... @@ -458,9 +458,11 @@ 458 458 "kind": "" , ~/~/ тип аутентификации 459 459 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 460 460 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 461 -} 462 462 463 +(% style="text-align:left" %) 464 +(% style="color:#000000; font-weight:normal" %)} 463 463 466 + 464 464 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 465 465 466 466 (% class="box infomessage" %) ... ... @@ -480,16 +480,19 @@ 480 480 481 481 (% style="color:#000000" %)Параметры в теле запроса (JSON): 482 482 483 -(% style="color:#000000" %){(%%) 486 +(% style="color:#000000" %){ 487 + 484 484 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 485 485 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 486 486 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 487 487 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 492 + 488 488 (% style="color:#000000" %)} 489 489 490 490 (% style="color:#000000" %)Ответ: 491 491 492 492 (% style="color:#000000" %){ (%%) 498 + 493 493 "id": "" , ~/~/ идентификатор пользователя 494 494 "lastName": "" , ~/~/ фамилия 495 495 "firstName": "" , ~/~/ имя ... ... @@ -503,6 +503,7 @@ 503 503 "sessionDuration":"", ~/~/ длительность сессии в минутах 504 504 "status": "1", ~/~/ статус пользователя 505 505 "lastLogged": "", ~/~/ дата/время последней авторизации 512 + 506 506 (% style="color:#000000" %)} 507 507 508 508 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -576,8 +576,10 @@ 576 576 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 577 577 578 578 (% lang="en-US" style="text-align:left" %) 579 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 580 - "id": "" , ~/~/ ID пользователя 586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 + 588 +(% lang="en-US" style="text-align:left" %) 589 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 581 581 "lastName": "" , ~/~/ фамилия 582 582 "firstName": "" , ~/~/ имя 583 583 "position": "" , ~/~/ должность ... ... @@ -599,7 +599,9 @@ 599 599 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 600 600 }, 601 601 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 602 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 611 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 612 + 613 +(% lang="en-US" style="text-align:left" %) 603 603 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 604 604 605 605 (% lang="en-US" style="text-align:left" %) ... ... @@ -606,8 +606,10 @@ 606 606 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 607 607 608 608 (% lang="en-US" style="text-align:left" %) 609 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 610 - "id": "" , ~/~/ идентификатор пользователя 620 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 621 + 622 +(% lang="en-US" style="text-align:left" %) 623 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 611 611 "lastName": "" , ~/~/ фамилия 612 612 "firstName": "" , ~/~/ имя 613 613 "position": "" , ~/~/ должность ... ... @@ -628,8 +628,10 @@ 628 628 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 629 629 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 630 630 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 631 -} 632 632 645 +(% lang="en-US" style="text-align:left" %) 646 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 647 + 633 633 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 634 634 635 635 (% class="box warningmessage" %) ... ... @@ -649,10 +649,12 @@ 649 649 650 650 (% style="color:#000000" %)Параметры в теле запроса (JSON): 651 651 652 -(% style="color:#000000" %){(%%) 667 +(% style="color:#000000" %){ 668 + 653 653 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 654 654 "description": "" , ~/~/ описание 655 655 "data": "" , ~/~/ данные, связанные со сменой статуса 672 + 656 656 (% style="color:#000000" %)} 657 657 658 658 (% style="text-align:left" %) ... ... @@ -674,7 +674,7 @@ 674 674 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 675 675 676 676 [ 677 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 694 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 678 678 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 679 679 ] 680 680 ... ... @@ -980,7 +980,7 @@ 980 980 981 981 Ответ: В случае успеха **Success 200** 982 982 983 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =1000 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 984 984 985 985 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 986 986 ... ... @@ -1016,15 +1016,19 @@ 1016 1016 "deviceTypeName": "", ~/~/ Название типа устройства 1017 1017 "sim1": "", ~/~/ Номер SIM1 1018 1018 "sim2": "", ~/~/ Номер SIM2 1036 + 1019 1019 "parentId": "", ~/~/ ID клиента-родителя 1020 1020 "parentName": "", ~/~/ Наименование клиента-родителя 1021 1021 "modelId": "", ~/~/ ID модели объекта 1022 1022 "modelName": "", ~/~/ Имя модели объекта 1041 + 1023 1023 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1024 1024 "unitName": "string", ~/~/ Наименование подразделения 1025 1025 "status": 0, ~/~/ Статус объекта 1045 + 1026 1026 "createdAt": "", ~/~/ Дата создания объекта 1027 1027 }, 1048 + 1028 1028 "customFields": [ ~/~/ Произвольные поля 1029 1029 { 1030 1030 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1047,7 +1047,8 @@ 1047 1047 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1048 1048 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1049 1049 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1050 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1071 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1072 + 1051 1051 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1052 1052 "mileageCoeff": 0, ~/~/ коэффициент пробега 1053 1053 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1077,6 +1077,7 @@ 1077 1077 "retries": 0 ~/~/ Количество попыток 1078 1078 } 1079 1079 ], 1102 + 1080 1080 "sensors": [ ~/~/ Датчики 1081 1081 { 1082 1082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1117,19 +1117,31 @@ 1117 1117 }, 1118 1118 1119 1119 ~/~/ Характерные для произвольного: 1143 + 1120 1120 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1145 + 1121 1121 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1147 + 1122 1122 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1149 + 1123 1123 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1151 + 1124 1124 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1153 + 1125 1125 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1155 + 1126 1126 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1157 + 1127 1127 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1159 + 1128 1128 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1161 + 1129 1129 ~/~/ "ValueOn": "Вкл.", 1163 + 1130 1130 ~/~/ "ValueOff": "Выкл." 1131 1131 "summaryMaxValue": 0 ~/~/ Макс. значение 1132 1132 } 1167 + 1133 1133 "drivers": [ ~/~/ Водители 1134 1134 { 1135 1135 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1138,6 +1138,7 @@ 1138 1138 "isDefault": true ~/~/ По умолчанию 1139 1139 } 1140 1140 ], 1176 + 1141 1141 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1142 1142 { 1143 1143 "id": "", ~/~/ ID задания ... ... @@ -1154,7 +1154,8 @@ 1154 1154 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1155 1155 } 1156 1156 ], 1157 -"statusHistory": [ ~/~/ История статусов 1193 + 1194 + "statusHistory": [ ~/~/ История статусов 1158 1158 { 1159 1159 "status": 0, 1160 1160 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1162,6 +1162,7 @@ 1162 1162 "additionalInfo": "string" 1163 1163 } 1164 1164 ] 1202 + 1165 1165 } 1166 1166 ))) 1167 1167 ... ... @@ -1171,24 +1171,8 @@ 1171 1171 (% style="text-align:left" %) 1172 1172 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1173 1173 1212 +===== ===== 1174 1174 1175 -== **Отправить команду на терминал** == 1176 - 1177 -(% class="box successmessage" %) 1178 -((( 1179 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1180 -))) 1181 - 1182 -Команда для отправки на тс. 1183 - 1184 -{ 1185 -"id": "", ~/~/идентификатор произвольного поля 1186 -"command": "", ~/~/ Текст команды 1187 -"retries": "", ~/~/ Количество попыток 1188 -"idTemplate": "" ~/~/ ID шаблона команды 1189 -} 1190 - 1191 - 1192 1192 == **Получить ответ на отправленную на ТС команду** == 1193 1193 1194 1194 (% class="box infomessage" %) ... ... @@ -1198,19 +1198,31 @@ 1198 1198 1199 1199 Идентификатор команды: cmdid 1200 1200 1223 + 1201 1201 Запрос от терминала на ответ команды 1202 1202 1226 + 1203 1203 Пример ответ от терминала: 1204 1204 1229 + 1205 1205 ID= "" ~/~/ идентификатор произвольного поля 1231 + 1206 1206 Soft="" ~/~/ версия софта 1233 + 1207 1207 GPS=4 ~/~/ тип трекера 1235 + 1208 1208 Time=11:05:43 28.06.24 ~/~/ время запроса 1237 + 1209 1209 Lat=45.056221 ~/~/ широта 1239 + 1210 1210 Lon=39.035938 ~/~/ долгота 1241 + 1211 1211 Speed=0.0 ~/~/ скорость 1243 + 1212 1212 Course=181.4 ~/~/направление 1213 1213 1246 + 1247 + 1214 1214 ((( 1215 1215 == **Список отправленных объекту команд с ответами** == 1216 1216 ... ... @@ -1221,21 +1221,36 @@ 1221 1221 1222 1222 Идентификатор ТС: vehicleId 1223 1223 1258 + 1224 1224 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1225 1225 1261 + 1226 1226 Пример ответа терминала 1227 1227 1228 -[ 1229 -{ 1230 -"id": "", ~/~/ идентификатор пользователя 1264 + 1265 +[ 1266 + 1267 +{ 1268 + 1269 +"id": "", ~/~/ идентификатор пользователя 1270 + 1231 1231 "commandText": "", ~/~/Текст команды. 1272 + 1232 1232 "templateId": "", ~/~/Идентификатор шаблона 1233 -"updated": "", ~/~/ Время отправки 1234 -"tryCount": 0, ~/~/ Количество попыток отправки команды 1274 + 1275 +"updated": "", ~/~/ Время отправки 1276 + 1277 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1278 + 1235 1235 "answer": "", ~/~/ Ответ терминала. 1280 + 1236 1236 "status": "" ~/~/ Статус отправки 1282 + 1237 1237 } 1284 + 1238 1238 ] 1286 + 1287 + 1239 1239 ))) 1240 1240 1241 1241 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == ... ... @@ -1255,7 +1255,8 @@ 1255 1255 1256 1256 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1257 1257 1258 -(% style="color:#000000" %){(%%) 1307 +(% style="color:#000000" %){ 1308 + 1259 1259 "parentId": "" , ~/~/ ID клиента 1260 1260 "name": "" , ~/~/ имя ТС 1261 1261 "imei": "" , ~/~/ IMEI ... ... @@ -1276,6 +1276,7 @@ 1276 1276 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1277 1277 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1278 1278 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1329 + 1279 1279 "mileageCalcMethod": 0, 1280 1280 "mileageCoeff": 0, 1281 1281 "locationByCellId": true, ... ... @@ -1308,6 +1308,7 @@ 1308 1308 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1309 1309 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1310 1310 } 1362 + 1311 1311 "drivers": [ ~/~/ Водители 1312 1312 { 1313 1313 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1322,7 +1322,8 @@ 1322 1322 "retries": 0 1323 1323 } 1324 1324 ], 1325 -"sensors": [ ~/~/ Датчики 1377 + 1378 + "sensors": [ ~/~/ Датчики 1326 1326 { 1327 1327 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1328 1328 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1360,17 +1360,29 @@ 1360 1360 "additionalProp2": "string", 1361 1361 "additionalProp3": "string" 1362 1362 }, 1416 + 1363 1363 ~/~/ Характерные для произвольного: 1418 + 1364 1364 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1420 + 1365 1365 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1422 + 1366 1366 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1424 + 1367 1367 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1426 + 1368 1368 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1428 + 1369 1369 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1430 + 1370 1370 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1432 + 1371 1371 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1434 + 1372 1372 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1436 + 1373 1373 ~/~/ "ValueOn": "Вкл.", 1438 + 1374 1374 ~/~/ "ValueOff": "Выкл." 1375 1375 "summaryMaxValue": 0 ~/~/ Макс. значение 1376 1376 } ... ... @@ -1389,7 +1389,8 @@ 1389 1389 1390 1390 (% style="color:#000000" %)Ответ: 1391 1391 1392 -(% style="color:#000000" %){(%%) 1457 +(% style="color:#000000" %){ 1458 + 1393 1393 "vehicleId": "", ~/~/ID ТС 1394 1394 "parentId": "", ~/~/Guid владельца ТС 1395 1395 "name": "", ~/~/Имя объекта ... ... @@ -1427,6 +1427,8 @@ 1427 1427 "kind": "", ~/~/ Вид периодичности по времени 1428 1428 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1429 1429 } 1496 + 1497 +(% style="text-align:left" %) 1430 1430 (% style="color:#000000" %)} 1431 1431 1432 1432 **Валидация:** ... ... @@ -1434,7 +1434,7 @@ 1434 1434 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1435 1435 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1436 1436 1437 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектовс основными параметрами**(%%) ==1505 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1438 1438 1439 1439 (% class="box infomessage" %) 1440 1440 ((( ... ... @@ -1485,7 +1485,8 @@ 1485 1485 (% style="color:#000000" %)Ответ: 1486 1486 1487 1487 (% style="color:#000000" %){ 1488 - "vehicleId": "" ~/~/ идентификатор объекта 1556 + 1557 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1489 1489 "name": "" ~/~/ наименование объекта 1490 1490 "imei": "" ~/~/ IMEI объекта 1491 1491 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1544,11 +1544,13 @@ 1544 1544 "data": "", ~/~/ Данные 1545 1545 "overwrite": false, ~/~/ Флаг перезаписи 1546 1546 "stage": "", ~/~/ Состояние, может быть null 1616 + 1547 1547 (% style="color:#000000" %)} 1548 1548 1549 1549 (% style="color:#000000" %)Ответ: 1550 1550 1551 -(% style="color:#000000" %){(%%) 1621 +(% style="color:#000000" %){ 1622 + 1552 1552 "status": "", ~/~/ значение статуса 1553 1553 "date": "", ~/~/ Дата смены статуса 1554 1554 "description": "", ~/~/ Описание ... ... @@ -1555,10 +1555,34 @@ 1555 1555 "data": "", ~/~/ Данные 1556 1556 "overwrite": false, ~/~/ Флаг перезаписи 1557 1557 "stage": "", ~/~/ Состояние 1629 + 1630 +(% style="text-align:left" %) 1558 1558 (% style="color:#000000" %) } 1559 1559 1560 -== == 1633 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1634 +**Отправить команду на терминал** 1561 1561 1636 +(% class="box successmessage" %) 1637 +((( 1638 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1639 +))) 1640 + 1641 +Команда для отправки на тс. 1642 + 1643 + 1644 +{ 1645 + 1646 +"id": "", ~/~/идентификатор произвольного поля 1647 + 1648 +"command": "", ~/~/ Текст команды 1649 + 1650 +"retries": "", ~/~/ Количество попыток 1651 + 1652 +"idTemplate": "" ~/~/ ID шаблона команды 1653 + 1654 +} 1655 + 1656 + 1562 1562 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1563 1563 1564 1564 (% class="box warningmessage" %) ... ... @@ -1646,7 +1646,8 @@ 1646 1646 "retries": 0 1647 1647 } 1648 1648 ], 1649 -"sensors": [ ~/~/ Датчики 1744 + 1745 + "sensors": [ ~/~/ Датчики 1650 1650 { 1651 1651 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1652 1652 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1684,17 +1684,29 @@ 1684 1684 "additionalProp2": "string", 1685 1685 "additionalProp3": "string" 1686 1686 }, 1783 + 1687 1687 ~/~/ Характерные для произвольного: 1785 + 1688 1688 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1787 + 1689 1689 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1789 + 1690 1690 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1791 + 1691 1691 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1793 + 1692 1692 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1795 + 1693 1693 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1797 + 1694 1694 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1799 + 1695 1695 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1801 + 1696 1696 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1803 + 1697 1697 ~/~/ "ValueOn": "Вкл.", 1805 + 1698 1698 ~/~/ "ValueOff": "Выкл." 1699 1699 "summaryMaxValue": 0 ~/~/ Макс. значение 1700 1700 } ... ... @@ -1714,7 +1714,9 @@ 1714 1714 (% style="color:#000000" %)Ответ: 1715 1715 1716 1716 (% lang="en-US" style="text-align:left" %) 1717 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1825 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1826 + 1827 +(% lang="en-US" style="text-align:left" %) 1718 1718 "vehicleId": "", ~/~/ ID ТС 1719 1719 "parentId": "", ~/~/ ID клиента 1720 1720 "name": "", ~/~/ имя ТС ... ... @@ -1755,6 +1755,8 @@ 1755 1755 "kind": "", ~/~/ Вид периодичности по времени 1756 1756 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1757 1757 } 1868 + 1869 +(% lang="en-US" style="text-align:left" %) 1758 1758 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1759 1759 1760 1760 **Валидация:** ... ... @@ -1801,9 +1801,12 @@ 1801 1801 1802 1802 (% style="color:#000000" %)Ответ: 1803 1803 1804 -(% style="color:#000000" %){(%%) 1916 +(% style="color:#000000" %){ 1917 + 1805 1805 "deviceTypeId" : "", ~/~/ ID типа устройства 1806 1806 "deviceTypeName" : "" ~/~/ Название типа устройства 1920 + 1921 +(% style="text-align:left" %) 1807 1807 (% style="color:#000000" %)} 1808 1808 1809 1809 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1825,10 +1825,13 @@ 1825 1825 1826 1826 (% style="color:#000000" %)Ответ: 1827 1827 1828 -(% style="color:#000000" %){(%%) 1943 +(% style="color:#000000" %){ 1944 + 1829 1829 "id": "", ~/~/ ID типа датчика 1830 1830 "name": "", ~/~/ Название 1831 1831 "description": "", ~/~/ Описание 1948 + 1949 +(% style="text-align:left" %) 1832 1832 (% style="color:#000000" %)} 1833 1833 1834 1834 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -2030,12 +2030,10 @@ 2030 2030 { 2031 2031 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2032 2032 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2033 - "mileage": 0, ~/~/ Пробег за период, километры 2034 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2035 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2036 - "motohours": 0, ~/~/ Моточасы за период, секунды 2037 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2038 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2151 + "mileageBegin": 0, ~/~/ Пробег на начало периода 2152 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 2153 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2154 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2039 2039 } 2040 2040 ] 2041 2041 } ... ... @@ -2084,12 +2084,6 @@ 2084 2084 } 2085 2085 ] 2086 2086 2087 -(% class="box warningmessage" %) 2088 -((( 2089 -Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2090 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2091 -))) 2092 - 2093 2093 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2094 2094 2095 2095 (% class="box infomessage" %) ... ... @@ -2153,42 +2153,74 @@ 2153 2153 Тело запроса: 2154 2154 2155 2155 { 2266 + 2156 2156 "vehicleIds": [ ], ~/~/ Список ID объектов 2268 + 2157 2157 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2270 + 2158 2158 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2272 + 2159 2159 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2274 + 2160 2160 } 2161 2161 2162 2162 Ответ: 2163 2163 2164 -[ 2279 +[ 2280 + 2165 2165 { 2282 + 2166 2166 "vehicleId": 0, ~/~/ ID объекта 2284 + 2167 2167 "vehicleName": "string", ~/~/ Имя объекта 2286 + 2168 2168 "moves": [ ~/~/ Событие движения 2288 + 2169 2169 { 2290 + 2170 2170 "mileage": 0, ~/~/ Пробег, км 2292 + 2171 2171 "eventId": 0, ~/~/ Идентификатор события 2294 + 2172 2172 "eventName": "string", ~/~/ Название события 2296 + 2173 2173 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2298 + 2174 2174 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2300 + 2175 2175 "duration": 0 ~/~/ Продолжительность события, секунд 2302 + 2176 2176 } 2304 + 2177 2177 ], 2306 + 2178 2178 "stops": [ ~/~/ События стоянок 2308 + 2179 2179 { 2310 + 2180 2180 "address": "string", ~/~/ Адрес события 2312 + 2181 2181 "eventId": 0, ~/~/ Идентификатор события 2314 + 2182 2182 "eventName": "string", ~/~/ Название события 2316 + 2183 2183 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2318 + 2184 2184 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2320 + 2185 2185 "duration": 0 ~/~/ Продолжительность события, секунд 2322 + 2323 + 2186 2186 } 2325 + 2187 2187 ] 2327 + 2188 2188 } 2329 + 2189 2189 ] 2190 2190 2191 2191 2333 + 2192 2192 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2193 2193 2194 2194 (% class="box infomessage" %) ... ... @@ -2225,6 +2225,7 @@ 2225 2225 } 2226 2226 2227 2227 2370 + 2228 2228 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2229 2229 2230 2230 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2532,32 +2532,6 @@ 2532 2532 2533 2533 Success 2534 2534 2535 - 2536 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2537 - 2538 -(% class="box warningmessage" %) 2539 -((( 2540 -**PUT** /api/v3/notifications/prolongation 2541 -))) 2542 - 2543 -Метод позволяет продлить уведомления. 2544 - 2545 -Метод запроса **PUT** 2546 - 2547 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2548 - 2549 -В заголовках запроса: X-Auth: Токен авторизации. 2550 - 2551 -Тело запроса: 2552 - 2553 -[ 2554 - 2555 -0 2556 - 2557 -] 2558 - 2559 -где 0 идентификатор ids. 2560 - 2561 2561 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2562 2562 2563 2563 (% class="box errormessage" %) ... ... @@ -3748,7 +3748,7 @@ 3748 3748 **POST /api/v3/vehicles/import/{agentId}** 3749 3749 ))) 3750 3750 3751 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение*.xls)**или **wlp. **Также они могут находится в** zip-архиве(один файл - один архив).**3868 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3752 3752 3753 3753 В пути указывается **agentId** - id клиента. 3754 3754 ... ... @@ -3760,7 +3760,7 @@ 3760 3760 3761 3761 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3762 3762 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3763 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace- Замена,Merge- Слияние,Add- Добавление3880 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3764 3764 3765 3765 В теле использовать тип **form-data,** тип значения** file** 3766 3766 ... ... @@ -4022,7 +4022,7 @@ 4022 4022 |dangerousDrivingViolations|Резкое вождение 4023 4023 |sensorViolations|Нарушение по датчику 4024 4024 |moveTime|Время в движении 4025 -|mileage|Пробег (км)4142 +|mileage|Пробег 4026 4026 |tripsCount|Количество рейсов 4027 4027 |motohours|Моточасы 4028 4028 |maxSpeed|Максимальная скорость ... ... @@ -4052,38 +4052,60 @@ 4052 4052 Параметры в теле запроса (JSON): 4053 4053 4054 4054 { 4172 + 4055 4055 "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4174 + 4056 4056 "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4057 - "ids": [ 4176 + 4177 + "ids": [ 4178 + 4058 4058 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4180 + 4059 4059 ], 4182 + 4060 4060 "timezone": 0 ~/~/Таймзона 4184 + 4061 4061 } 4062 4062 4063 - 4064 4064 Ответ: 4188 + 4065 4065 { 4190 + 4066 4066 "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4192 + 4067 4067 "driver": "string", ~/~/Водители, привязанные к ТК 4194 + 4068 4068 "object": "string", ~/~/Наименование ТС 4196 + 4069 4069 "amount": 0, ~/~/Количество топлива 4198 + 4070 4070 "amountDut": 0, ~/~/Количество по ДУТ 4200 + 4071 4071 "amountDiff": 0, ~/~/Разница, л 4202 + 4072 4072 "amountDiffPerc": 0, ~/~/Разница, % 4204 + 4073 4073 "summa": 0, ~/~/Стоимость, руб 4206 + 4074 4074 "serviceName": "string", ~/~/Тип топлива 4208 + 4075 4075 "price": 0, ~/~/Цена за литр, руб 4210 + 4076 4076 "cardName": "string", ~/~/Наименование ТК 4212 + 4077 4077 "cardNum": "string", ~/~/Номер ТК 4214 + 4078 4078 "operator": "string", ~/~/Оператор ТК 4216 + 4079 4079 "address": "string" ~/~/Адрес АЗС 4218 + 4080 4080 } 4081 4081 4082 4082 4083 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4222 +==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ==== 4084 4084 4085 4085 4086 -== **Получение полных данных о ретрансляторе** == 4225 +==== **Получение полных данных о ретрансляторе** ==== 4087 4087 4088 4088 (% class="box infomessage" %) 4089 4089 ((( ... ... @@ -4095,27 +4095,44 @@ 4095 4095 4096 4096 Пример ответа: 4097 4097 4098 -{ 4237 +{ 4238 + 4099 4099 "description": "", ~/~/ Определяет описание 4240 + 4100 4100 "subscriberId": "", ~/~/ Подписчик 4242 + 4101 4101 "protocolType": 0, ~/~/ Тип протокола 4244 + 4102 4102 "isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4246 + 4103 4103 "address": "string", ~/~/ Адрес события 4248 + 4104 4104 "objects": [ ~/~/Объекты для ретрансляции 4105 -{ 4106 -"id": "", ~/~/ Идентификатор объекта ретрансляции 4107 -"name": "", ~/~/ Наименование объекта ретрансляции 4108 -"imei": "", ~/~/ IMEI объекта 4250 + 4251 +{ 4252 + 4253 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4254 + 4255 +"name": "", ~/~/ Наименование объекта ретрансляции 4256 + 4257 +"imei": "", ~/~/ IMEI объекта 4258 + 4109 4109 "isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4260 + 4110 4110 } 4111 - ], 4112 -"id": "", ~/~/ идентификатор пользователя 4262 + 4263 + ], 4264 + 4265 +"id": "", ~/~/ идентификатор пользователя 4266 + 4113 4113 "parentId": "", ~/~/Guid родителя 4268 + 4114 4114 "deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4270 + 4115 4115 } 4116 4116 4117 4117 4118 -== **Удаление данных ретранслятора** == 4274 +==== **Удаление данных ретранслятора** ==== 4119 4119 4120 4120 (% class="box infomessage" %) 4121 4121 ((( ... ... @@ -4125,7 +4125,7 @@ 4125 4125 Параметр запроса: ID 4126 4126 4127 4127 4128 -== **Создание ретранслятора** == 4284 +==== **Создание ретранслятора** ==== 4129 4129 4130 4130 (% class="box infomessage" %) 4131 4131 ((( ... ... @@ -4134,45 +4134,77 @@ 4134 4134 4135 4135 Запрос: 4136 4136 4137 -{ 4293 + 4294 +{ 4295 + 4138 4138 "description": "", ~/~/ Описание 4297 + 4139 4139 "subscriberId": "", ~/~/ Подписчик 4299 + 4140 4140 "protocolType": 0, ~/~/ Тип протокола 4301 + 4141 4141 "address": "", ~/~/ Адрес ретрансляции 4303 + 4142 4142 "isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4305 + 4143 4143 "objects": [ ~/~/Объекты для ретрансляции 4144 -{ 4145 -"id": "", ~/~/ идентификатор пользователя 4307 + 4308 +{ 4309 + 4310 +"id": "", ~/~/ идентификатор пользователя 4311 + 4146 4146 "imei": "", ~/~/IMEI объекта 4147 -"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4313 + 4314 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4315 + 4148 4148 } 4317 + 4149 4149 ] 4319 + 4150 4150 } 4151 4151 4152 4152 4153 -Ответ: 4154 4154 4155 -{ 4324 +Ответ 4325 + 4326 +{ 4327 + 4156 4156 "description": "string", ~/~/ Определяет описание 4329 + 4157 4157 "subscriberId": "", ~/~/ идентификатор запроса 4331 + 4158 4158 "protocolType": 0, ~/~/ Тип протокола 4333 + 4159 4159 "isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4335 + 4160 4160 "address": "", ~/~/ Адрес события 4337 + 4161 4161 "objects": [ ~/~/Объекты для ретрансляции 4162 -{ 4163 -"id": "", ~/~/ идентификатор пользователя 4164 -"name": "string", ~/~/ Название уведомления 4165 -"imei": "string", ~/~/IMEI объекта 4166 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4339 + 4340 +{ 4341 + 4342 +"id": "", ~/~/ идентификатор пользователя 4343 + 4344 +"name": "string", ~/~/ Название уведомления 4345 + 4346 +"imei": "string", ~/~/IMEI объекта 4347 + 4348 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4349 + 4167 4167 } 4168 - ], 4169 -"id": "", ~/~/ идентификатор пользователя 4351 + 4352 + ], 4353 + 4354 +"id": "", ~/~/ идентификатор пользователя 4355 + 4170 4170 "parentId": "", ~/~/ Guid идентификатор родителя 4357 + 4171 4171 "deleted": true ~/~/ Признак удаления 4359 + 4172 4172 } 4173 4173 4174 4174 4175 -== **Редактирование ретранслятора** == 4363 +==== **Редактирование ретранслятора** ==== 4176 4176 4177 4177 (% class="box infomessage" %) 4178 4178 ((( ... ... @@ -4181,48 +4181,81 @@ 4181 4181 4182 4182 Пример запроса: 4183 4183 4184 -{ 4185 -"id": "", ~/~/ идентификатор пользователя 4372 +{ 4373 + 4374 +"id": "", ~/~/ идентификатор пользователя 4375 + 4186 4186 "description": "string", ~/~/ Определяет описание 4377 + 4187 4187 "subscriberId": "", ~/~/ идентификатор запроса 4379 + 4188 4188 "protocolType": 0, ~/~/ Тип протокола 4189 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4381 + 4382 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4383 + 4190 4190 "address": "string", ~/~/ Адрес события 4385 + 4191 4191 "objects": ~/~/Объекты для ретрансляции 4192 -[ 4193 -{ 4194 -"id": "", ~/~/ идентификатор пользователя 4387 + 4388 +[ 4389 + 4390 +{ 4391 + 4392 +"id": "", ~/~/ идентификатор пользователя 4393 + 4195 4195 "imei": "", ~/~/IMEI объекта 4196 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4395 + 4396 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4397 + 4197 4197 } 4399 + 4198 4198 ] 4401 + 4199 4199 } 4200 4200 4201 4201 4202 4202 Пример ответа: 4203 4203 4204 -{ 4407 +{ 4408 + 4205 4205 "description": "", ~/~/ Определяет описание 4410 + 4206 4206 "subscriberId": "", ~/~/ идентификатор запроса 4412 + 4207 4207 "protocolType": 0, ~/~/ Тип протокола 4208 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4414 + 4415 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4416 + 4209 4209 "address": "string", ~/~/ Адрес события 4418 + 4210 4210 "objects": [ ~/~/Объекты для ретрансляции 4211 -{ 4212 -"id": "", ~/~/ идентификатор пользователя 4213 -"name": "string", ~/~/ Название уведомления 4420 + 4421 +{ 4422 + 4423 +"id": "", ~/~/ идентификатор пользователя 4424 + 4425 +"name": "string", ~/~/ Название уведомления 4426 + 4214 4214 "imei": "", ~/~/IMEI объекта 4215 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4428 + 4429 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4430 + 4216 4216 } 4432 + 4217 4217 ], 4218 -"id": "", ~/~/ идентификатор пользователя 4434 + 4435 +"id": "", ~/~/ идентификатор пользователя 4436 + 4219 4219 "parentId": "", ~/~/ Guid идентификатор родителя 4438 + 4220 4220 "deleted": true ~/~/ Признак удаления 4440 + 4221 4221 } 4222 4222 4223 4223 4224 -== **Получение списка ретранслятора клиента** == 4225 4225 4445 +==== **Получение списка ретранслятора клиента** ==== 4446 + 4226 4226 (% class="box infomessage" %) 4227 4227 ((( 4228 4228 **POST /api/v3/retranslations/find** ... ... @@ -4230,32 +4230,53 @@ 4230 4230 4231 4231 Пример запроса: 4232 4232 4233 -{ 4234 -"id": "", ~/~/ идентификатор пользователя 4454 + 4455 +{ 4456 + 4457 +"id": "", ~/~/ идентификатор пользователя 4458 + 4235 4235 "search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4460 + 4236 4236 "parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4462 + 4237 4237 } 4238 4238 4239 -Ответ: 4240 4240 4241 -[ 4242 -{ 4466 + 4467 +Ответ 4468 + 4469 + 4470 +[ 4471 + 4472 +{ 4473 + 4243 4243 "description": "", ~/~/ Определяет описание 4475 + 4244 4244 "subscriberId": "", ~/~/ идентификатор запроса 4477 + 4245 4245 "protocolType": 0, ~/~/ Тип протокола 4246 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4479 + 4480 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4481 + 4247 4247 "address": "string", ~/~/ Адрес события 4248 -"id": "", ~/~/ идентификатор пользователя 4483 + 4484 +"id": "", ~/~/ идентификатор пользователя 4485 + 4249 4249 "parentId": "", ~/~/ Guid идентификатор родителя 4487 + 4250 4250 "deleted": true ~/~/ Признак удаления 4489 + 4251 4251 } 4491 + 4252 4252 ] 4253 4253 4254 4254 4255 -= (% style="color:#000000; font-size:18.6667px" %) **Раздел: Отчеты**(%%) =4495 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) = 4256 4256 4257 -== **API для отчета по выгрузке комбайнов** == 4258 4258 4498 +==== **API для отчета по выгрузке комбайнов** ==== 4499 + 4500 + 4259 4259 (% class="box infomessage" %) 4260 4260 ((( 4261 4261 POST **/api/v3/Reports/harvesterUnloading** ... ... @@ -4263,70 +4263,134 @@ 4263 4263 4264 4264 Пример запроса: 4265 4265 4508 + 4266 4266 { 4510 + 4267 4267 "byTime": 0, ~/~/ Объединение событий по времени 4512 + 4268 4268 "byDist": 0, ~/~/ Объединение событий по расстоянию 4514 + 4269 4269 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4516 + 4270 4270 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4518 + 4271 4271 "showNearestObjects": true, ~/~/Показывать объекты рядом? 4520 + 4272 4272 "vehicleIds": [ ~/~/ Список id объектов для анализа 4522 + 4273 4273 0 4524 + 4274 4274 ], 4526 + 4275 4275 "from": "", ~/~/ Дата и время начало запроса 4528 + 4276 4276 "to": "", ~/~/ Дата и время окончания запроса 4530 + 4277 4277 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4532 + 4278 4278 } 4279 4279 4535 + 4536 + 4280 4280 Пример ответа: 4281 4281 4282 -[ 4539 + 4540 +[ 4541 + 4283 4283 { 4543 + 4284 4284 "harvesterName": "", ~/~/Комбайн, номер 4545 + 4285 4285 "harvesterId": 0, ~/~/Комбайн, id 4547 + 4286 4286 "harvesterModel": "", ~/~/ Модель комбайна 4287 -"hopperCapacity": 0, ~/~/ Объем бункера м3 4549 + 4550 + "hopperCapacity": 0, ~/~/ Объем бункера м3 4551 + 4288 4288 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4553 + 4289 4289 "events": [ ~/~/Список событий в разрезе комбайна 4555 + 4290 4290 { 4557 + 4291 4291 "driverId": "", ~/~/Идентификатор водителя 4559 + 4292 4292 "driverName": "", ~/~/Водитель комбайна, ФИО 4561 + 4293 4293 "RFID": "", ~/~/ идентификатор карты-метки 4563 + 4294 4294 "rfidName": "", ~/~/Водитель комбайна, имя метки 4565 + 4295 4295 "vehicleId": 0, ~/~/идентификатор объекта 4567 + 4296 4296 "vehicleName": "string", ~/~/ Имя объекта 4569 + 4297 4297 "modelName": "string", ~/~/ Имя модели объекта 4571 + 4298 4298 "nearestVehicles": [ ~/~/Объекты рядом 4573 + 4299 4299 { 4575 + 4300 4300 "vehicleId": 0, ~/~/идентификатор объекта 4577 + 4301 4301 "vehicleName": "string" ~/~/ Имя объекта 4579 + 4302 4302 } 4581 + 4303 4303 ], 4583 + 4304 4304 "fields": [ ~/~/Поля, где происходила выгрузка 4585 + 4305 4305 { 4306 - "id": 0, ~/~/ идентификатор пользователя 4307 - "name": "string" ~/~/ имя пользователя 4587 + 4588 + "id": 0, ~/~/ идентификатор пользователя 4589 + 4590 + "name": "string" ~/~/ имя пользователя 4591 + 4308 4308 } 4593 + 4309 4309 ], 4595 + 4310 4310 "event": "string", ~/~/Событие 4597 + 4311 4311 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4599 + 4312 4312 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4601 + 4313 4313 "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4603 + 4314 4314 "cultureName": "string", ~/~/ название культуры 4605 + 4315 4315 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4607 + 4316 4316 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4609 + 4317 4317 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4611 + 4318 4318 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4613 + 4319 4319 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4615 + 4320 4320 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4617 + 4321 4321 "issued": 0, ~/~/Выдано, бункеров 4619 + 4322 4322 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4621 + 4323 4323 "latitude": 0, ~/~/Широта 4623 + 4324 4324 "longitude": 0, ~/~/ Долгота 4625 + 4325 4325 "litresAway": 0, ~/~/Отдано, л 4627 + 4326 4326 "m3Away": 0 ~/~/Отдано, м3 4629 + 4327 4327 } 4631 + 4328 4328 ] 4633 + 4329 4329 } 4635 + 4330 4330 ] 4331 4331 4332 4332 ... ... @@ -4348,27 +4348,48 @@ 4348 4348 4349 4349 Ответ: 4350 4350 4351 -[ 4657 +[ 4658 + 4352 4352 { 4660 + 4353 4353 "recordTime": "", ~/~/Время записи 4662 + 4354 4354 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4664 + 4355 4355 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4666 + 4356 4356 "objectId": 0, ~/~/ID объекта, помещённого в корзину 4668 + 4357 4357 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4670 + 4358 4358 "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4672 + 4359 4359 "details": { ~/~/Список деталей объекта, помещённого в корзину 4360 - "items": [ ~/~/ 4674 + 4675 + "items": [ ~/~/ [ 4676 + 4361 4361 nullable: true ~/~/Детали 4678 + 4362 4362 { 4680 + 4363 4363 "name": "string", ~/~/наименование столбца 4682 + 4364 4364 "value": "string" ~/~/содержание столбца 4684 + 4365 4365 } 4686 + 4366 4366 ] 4688 + 4367 4367 }, 4368 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4690 + 4691 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4692 + 4369 4369 "string" 4694 + 4370 4370 ] 4696 + 4371 4371 } 4698 + 4372 4372 ] 4373 4373 4374 4374 ... ... @@ -4383,33 +4383,56 @@ 4383 4383 4384 4384 Пример запроса: 4385 4385 4713 + 4386 4386 [ 4387 -0 4715 + 4716 + 0 4717 + 4388 4388 ] 4389 - 4390 4390 4720 + 4391 4391 Пример ответа: 4392 4392 4393 -[ 4394 -{ 4723 +[ 4724 + 4725 + { 4726 + 4395 4395 "recordTime": "", ~/~/Время записи 4728 + 4396 4396 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4730 + 4397 4397 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4732 + 4398 4398 "objectId": 0, ~/~/ID объекта, помещённого в корзин 4734 + 4399 4399 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4736 + 4400 4400 "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4738 + 4401 4401 "details": { ~/~/Список деталей объекта, помещённого в корзину 4740 + 4402 4402 "items": [ ~/~/Детали 4742 + 4403 4403 { 4744 + 4404 4404 "name": "", ~/~/Имя свойства 4746 + 4405 4405 "value": "" ~/~/Значение свойства 4748 + 4406 4406 } 4750 + 4407 4407 ] 4752 + 4408 4408 }, 4754 + 4409 4409 "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4756 + 4410 4410 "" 4758 + 4411 4411 ] 4760 + 4412 4412 } 4762 + 4413 4413 ] 4414 4414 4415 4415 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». ... ... @@ -4432,41 +4432,55 @@ 4432 4432 4433 4433 Пример запроса: 4434 4434 4435 -((( 4436 4436 [ 4437 -))) 4438 4438 4439 -((( 4440 4440 0 4441 -))) 4442 4442 4443 -((( 4444 4444 ] 4445 -))) 4446 4446 4447 4447 4448 4448 Пример ответа: 4449 4449 4450 4450 [ 4451 -{ 4795 + 4796 + { 4797 + 4452 4452 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4799 + 4453 4453 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4801 + 4454 4454 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4803 + 4455 4455 "objectId": 0, ~/~/ID объекта, помещённого в корзину 4805 + 4456 4456 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4807 + 4457 4457 "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4809 + 4458 4458 "details": { ~/~/Список деталей объекта, помещённого в корзину 4811 + 4459 4459 "items": [ ~/~/Детали 4813 + 4460 4460 { 4815 + 4461 4461 "name": "string", ~/~/Имя свойства 4817 + 4462 4462 "value": "string" ~/~/Значение свойства 4819 + 4463 4463 } 4821 + 4464 4464 ] 4823 + 4465 4465 }, 4825 + 4466 4466 "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4827 + 4467 4467 "string" 4829 + 4468 4468 ] 4831 + 4469 4469 } 4833 + 4470 4470 ] 4471 4471 4472 4472