Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
<
>
edited by Андрей Калиновский
on 2024/10/23 09:09
on 2024/10/23 09:09
edited by Андрей Калиновский
on 2024/03/18 11:12
on 2024/03/18 11:12
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -16,18 +16,9 @@ 16 16 17 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 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. ... ... @@ -65,9 +65,6 @@ 65 65 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 66 66 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 67 67 68 -(% class="wikigeneratedid" %) 69 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 70 - 71 71 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 72 72 73 73 (% class="box infomessage" %) ... ... @@ -234,6 +234,7 @@ 234 234 "bankKS": "string" ~/~/ корр. счёт 235 235 } 236 236 229 + 237 237 Ответ: 238 238 239 239 { ... ... @@ -427,6 +427,7 @@ 427 427 ], 428 428 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 429 429 } 423 + 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 пользователя 437 + 438 +(% style="text-align:left" %) 439 +(% style="color:#000000; font-weight:normal" %){ 440 + 441 +(% style="text-align:left" %) 442 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 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 460 +(% style="text-align:left" %) 461 +(% style="color:#000000; font-weight:normal" %)} 463 463 463 + 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" %){(%%) 483 +(% style="color:#000000" %){ 484 + 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 - неважно 489 + 488 488 (% style="color:#000000" %)} 489 489 490 490 (% style="color:#000000" %)Ответ: 491 491 492 492 (% style="color:#000000" %){ (%%) 495 + 493 493 "id": "" , ~/~/ идентификатор пользователя 494 494 "lastName": "" , ~/~/ фамилия 495 495 "firstName": "" , ~/~/ имя ... ... @@ -503,6 +503,7 @@ 503 503 "sessionDuration":"", ~/~/ длительность сессии в минутах 504 504 "status": "1", ~/~/ статус пользователя 505 505 "lastLogged": "", ~/~/ дата/время последней авторизации 509 + 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 пользователя 583 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 584 + 585 +(% lang="en-US" style="text-align:left" %) 586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 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» названия группы пользователя(%%) 608 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 609 + 610 +(% 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": "" , ~/~/ идентификатор пользователя 617 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 618 + 619 +(% lang="en-US" style="text-align:left" %) 620 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 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 642 +(% lang="en-US" style="text-align:left" %) 643 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 644 + 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" %){(%%) 664 +(% style="color:#000000" %){ 665 + 653 653 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 654 654 "description": "" , ~/~/ описание 655 655 "data": "" , ~/~/ данные, связанные со сменой статуса 669 + 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", 691 + "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" %)Раздел: **Транспортные средства (объекты)**(%%) =997 += (% 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 1033 + 1019 1019 "parentId": "", ~/~/ ID клиента-родителя 1020 1020 "parentName": "", ~/~/ Наименование клиента-родителя 1021 1021 "modelId": "", ~/~/ ID модели объекта 1022 1022 "modelName": "", ~/~/ Имя модели объекта 1038 + 1023 1023 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1024 1024 "unitName": "string", ~/~/ Наименование подразделения 1025 1025 "status": 0, ~/~/ Статус объекта 1042 + 1026 1026 "createdAt": "", ~/~/ Дата создания объекта 1027 1027 }, 1045 + 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": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1068 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1069 + 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 ], 1099 + 1080 1080 "sensors": [ ~/~/ Датчики 1081 1081 { 1082 1082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1117,19 +1117,31 @@ 1117 1117 }, 1118 1118 1119 1119 ~/~/ Характерные для произвольного: 1140 + 1120 1120 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1142 + 1121 1121 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1144 + 1122 1122 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1146 + 1123 1123 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1148 + 1124 1124 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1150 + 1125 1125 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1152 + 1126 1126 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1154 + 1127 1127 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1156 + 1128 1128 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1158 + 1129 1129 ~/~/ "ValueOn": "Вкл.", 1160 + 1130 1130 ~/~/ "ValueOff": "Выкл." 1131 1131 "summaryMaxValue": 0 ~/~/ Макс. значение 1132 1132 } 1164 + 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 ], 1173 + 1141 1141 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1142 1142 { 1143 1143 "id": "", ~/~/ ID задания ... ... @@ -1154,7 +1154,8 @@ 1154 1154 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1155 1155 } 1156 1156 ], 1157 -"statusHistory": [ ~/~/ История статусов 1190 + 1191 + "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 ] 1199 + 1165 1165 } 1166 1166 ))) 1167 1167 ... ... @@ -1171,73 +1171,6 @@ 1171 1171 (% style="text-align:left" %) 1172 1172 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1173 1173 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 -== **Получить ответ на отправленную на ТС команду** == 1193 - 1194 -(% class="box infomessage" %) 1195 -((( 1196 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1197 -))) 1198 - 1199 -Идентификатор команды: cmdid 1200 - 1201 -Запрос от терминала на ответ команды 1202 - 1203 -Пример ответ от терминала: 1204 - 1205 -ID= "" ~/~/ идентификатор произвольного поля 1206 -Soft="" ~/~/ версия софта 1207 -GPS=4 ~/~/ тип трекера 1208 -Time=11:05:43 28.06.24 ~/~/ время запроса 1209 -Lat=45.056221 ~/~/ широта 1210 -Lon=39.035938 ~/~/ долгота 1211 -Speed=0.0 ~/~/ скорость 1212 -Course=181.4 ~/~/направление 1213 - 1214 -((( 1215 -== **Список отправленных объекту команд с ответами** == 1216 - 1217 -(% class="box infomessage" %) 1218 -((( 1219 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1220 -))) 1221 - 1222 -Идентификатор ТС: vehicleId 1223 - 1224 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1225 - 1226 -Пример ответа терминала 1227 - 1228 -[ 1229 -{ 1230 -"id": "", ~/~/ идентификатор пользователя 1231 -"commandText": "", ~/~/Текст команды. 1232 -"templateId": "", ~/~/Идентификатор шаблона 1233 -"updated": "", ~/~/ Время отправки 1234 -"tryCount": 0, ~/~/ Количество попыток отправки команды 1235 -"answer": "", ~/~/ Ответ терминала. 1236 -"status": "" ~/~/ Статус отправки 1237 -} 1238 -] 1239 -))) 1240 - 1241 1241 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1242 1242 1243 1243 (% class="box successmessage" %) ... ... @@ -1255,7 +1255,8 @@ 1255 1255 1256 1256 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1257 1257 1258 -(% style="color:#000000" %){(%%) 1226 +(% style="color:#000000" %){ 1227 + 1259 1259 "parentId": "" , ~/~/ ID клиента 1260 1260 "name": "" , ~/~/ имя ТС 1261 1261 "imei": "" , ~/~/ IMEI ... ... @@ -1276,6 +1276,7 @@ 1276 1276 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1277 1277 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1278 1278 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1248 + 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 } 1281 + 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": [ ~/~/ Датчики 1296 + 1297 + "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 }, 1335 + 1363 1363 ~/~/ Характерные для произвольного: 1337 + 1364 1364 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1339 + 1365 1365 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1341 + 1366 1366 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1343 + 1367 1367 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1345 + 1368 1368 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1347 + 1369 1369 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1349 + 1370 1370 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1351 + 1371 1371 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1353 + 1372 1372 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1355 + 1373 1373 ~/~/ "ValueOn": "Вкл.", 1357 + 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" %){(%%) 1376 +(% style="color:#000000" %){ 1377 + 1393 1393 "vehicleId": "", ~/~/ID ТС 1394 1394 "parentId": "", ~/~/Guid владельца ТС 1395 1395 "name": "", ~/~/Имя объекта ... ... @@ -1427,6 +1427,8 @@ 1427 1427 "kind": "", ~/~/ Вид периодичности по времени 1428 1428 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1429 1429 } 1415 + 1416 +(% 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" %)**Получение списка объектовс основными параметрами**(%%) ==1424 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1438 1438 1439 1439 (% class="box infomessage" %) 1440 1440 ((( ... ... @@ -1441,7 +1441,7 @@ 1441 1441 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1442 1442 ))) 1443 1443 1444 -(% style="color:#000000" %)Метод позволяет получить список доступныхобъектовмониторинга (транспортных средств)с их основнымипараметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1431 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1445 1445 1446 1446 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1447 1447 ... ... @@ -1485,7 +1485,8 @@ 1485 1485 (% style="color:#000000" %)Ответ: 1486 1486 1487 1487 (% style="color:#000000" %){ 1488 - "vehicleId": "" ~/~/ идентификатор объекта 1475 + 1476 +(% 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 1535 + 1547 1547 (% style="color:#000000" %)} 1548 1548 1549 1549 (% style="color:#000000" %)Ответ: 1550 1550 1551 -(% style="color:#000000" %){(%%) 1540 +(% style="color:#000000" %){ 1541 + 1552 1552 "status": "", ~/~/ значение статуса 1553 1553 "date": "", ~/~/ Дата смены статуса 1554 1554 "description": "", ~/~/ Описание ... ... @@ -1555,10 +1555,10 @@ 1555 1555 "data": "", ~/~/ Данные 1556 1556 "overwrite": false, ~/~/ Флаг перезаписи 1557 1557 "stage": "", ~/~/ Состояние 1548 + 1549 +(% style="text-align:left" %) 1558 1558 (% style="color:#000000" %) } 1559 1559 1560 -== == 1561 - 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": [ ~/~/ Датчики 1639 + 1640 + "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 }, 1678 + 1687 1687 ~/~/ Характерные для произвольного: 1680 + 1688 1688 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1682 + 1689 1689 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1684 + 1690 1690 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1686 + 1691 1691 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1688 + 1692 1692 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1690 + 1693 1693 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1692 + 1694 1694 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1694 + 1695 1695 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1696 + 1696 1696 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1698 + 1697 1697 ~/~/ "ValueOn": "Вкл.", 1700 + 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" %){ (%%) 1720 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1721 + 1722 +(% 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 } 1763 + 1764 +(% 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" %){(%%) 1811 +(% style="color:#000000" %){ 1812 + 1805 1805 "deviceTypeId" : "", ~/~/ ID типа устройства 1806 1806 "deviceTypeName" : "" ~/~/ Название типа устройства 1815 + 1816 +(% 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" %){(%%) 1838 +(% style="color:#000000" %){ 1839 + 1829 1829 "id": "", ~/~/ ID типа датчика 1830 1830 "name": "", ~/~/ Название 1831 1831 "description": "", ~/~/ Описание 1843 + 1844 +(% 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 ~/~/ Моточасы на окончание периода, секунды 2046 + "mileageBegin": 0, ~/~/ Пробег на начало периода 2047 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 2048 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2049 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2039 2039 } 2040 2040 ] 2041 2041 } ... ... @@ -2147,42 +2147,74 @@ 2147 2147 Тело запроса: 2148 2148 2149 2149 { 2161 + 2150 2150 "vehicleIds": [ ], ~/~/ Список ID объектов 2163 + 2151 2151 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2165 + 2152 2152 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2167 + 2153 2153 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2169 + 2154 2154 } 2155 2155 2156 2156 Ответ: 2157 2157 2158 -[ 2174 +[ 2175 + 2159 2159 { 2177 + 2160 2160 "vehicleId": 0, ~/~/ ID объекта 2179 + 2161 2161 "vehicleName": "string", ~/~/ Имя объекта 2181 + 2162 2162 "moves": [ ~/~/ Событие движения 2183 + 2163 2163 { 2185 + 2164 2164 "mileage": 0, ~/~/ Пробег, км 2187 + 2165 2165 "eventId": 0, ~/~/ Идентификатор события 2189 + 2166 2166 "eventName": "string", ~/~/ Название события 2191 + 2167 2167 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2193 + 2168 2168 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2195 + 2169 2169 "duration": 0 ~/~/ Продолжительность события, секунд 2197 + 2170 2170 } 2199 + 2171 2171 ], 2201 + 2172 2172 "stops": [ ~/~/ События стоянок 2203 + 2173 2173 { 2205 + 2174 2174 "address": "string", ~/~/ Адрес события 2207 + 2175 2175 "eventId": 0, ~/~/ Идентификатор события 2209 + 2176 2176 "eventName": "string", ~/~/ Название события 2211 + 2177 2177 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2213 + 2178 2178 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2215 + 2179 2179 "duration": 0 ~/~/ Продолжительность события, секунд 2217 + 2218 + 2180 2180 } 2220 + 2181 2181 ] 2222 + 2182 2182 } 2224 + 2183 2183 ] 2184 2184 2185 2185 2228 + 2186 2186 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2187 2187 2188 2188 (% class="box infomessage" %) ... ... @@ -2219,6 +2219,7 @@ 2219 2219 } 2220 2220 2221 2221 2265 + 2222 2222 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2223 2223 2224 2224 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2526,32 +2526,6 @@ 2526 2526 2527 2527 Success 2528 2528 2529 - 2530 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2531 - 2532 -(% class="box warningmessage" %) 2533 -((( 2534 -**PUT** /api/v3/notifications/prolongation 2535 -))) 2536 - 2537 -Метод позволяет продлить уведомления. 2538 - 2539 -Метод запроса **PUT** 2540 - 2541 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2542 - 2543 -В заголовках запроса: X-Auth: Токен авторизации. 2544 - 2545 -Тело запроса: 2546 - 2547 -[ 2548 - 2549 -0 2550 - 2551 -] 2552 - 2553 -где 0 идентификатор ids. 2554 - 2555 2555 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2556 2556 2557 2557 (% class="box errormessage" %) ... ... @@ -3742,7 +3742,7 @@ 3742 3742 **POST /api/v3/vehicles/import/{agentId}** 3743 3743 ))) 3744 3744 3745 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение*.xls)**или **wlp. **Также они могут находится в** zip-архиве(один файл - один архив).**3763 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3746 3746 3747 3747 В пути указывается **agentId** - id клиента. 3748 3748 ... ... @@ -3754,7 +3754,7 @@ 3754 3754 3755 3755 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3756 3756 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3757 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace- Замена,Merge- Слияние,Add- Добавление3775 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3758 3758 3759 3759 В теле использовать тип **form-data,** тип значения** file** 3760 3760 ... ... @@ -4016,7 +4016,7 @@ 4016 4016 |dangerousDrivingViolations|Резкое вождение 4017 4017 |sensorViolations|Нарушение по датчику 4018 4018 |moveTime|Время в движении 4019 -|mileage|Пробег (км)4037 +|mileage|Пробег 4020 4020 |tripsCount|Количество рейсов 4021 4021 |motohours|Моточасы 4022 4022 |maxSpeed|Максимальная скорость ... ... @@ -4031,304 +4031,72 @@ 4031 4031 4032 4032 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4033 4033 4034 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК» . Метод позволяет получить транзакции по нескольким топливным картам.4052 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК» 4035 4035 4036 4036 (% class="box infomessage" %) 4037 4037 ((( 4038 -POST 4056 +**POST**/api/v3/fuelcards/transactions 4039 4039 ))) 4040 4040 4041 - Методзапроса:POST4059 +Запрос должен содержать параметры: 4042 4042 4043 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4044 -\\В заголовках запроса: X-Auth: Токен авторизации 4045 - 4046 -Параметры в теле запроса (JSON): 4047 - 4048 4048 { 4049 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4050 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4051 - "ids": [ 4052 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4053 - ], 4054 - "timezone": 0 ~/~/Таймзона 4055 -} 4056 4056 4063 + "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения 4057 4057 4058 -Ответ: 4059 - { 4060 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4061 - "driver": "string", ~/~/Водители, привязанные к ТК 4062 - "object": "string", ~/~/Наименование ТС 4063 - "amount": 0, ~/~/Количество топлива 4064 - "amountDut": 0, ~/~/Количество по ДУТ 4065 - "amountDiff": 0, ~/~/Разница, л 4066 - "amountDiffPerc": 0, ~/~/Разница, % 4067 - "summa": 0, ~/~/Стоимость, руб 4068 - "serviceName": "string", ~/~/Тип топлива 4069 - "price": 0, ~/~/Цена за литр, руб 4070 - "cardName": "string", ~/~/Наименование ТК 4071 - "cardNum": "string", ~/~/Номер ТК 4072 - "operator": "string", ~/~/Оператор ТК 4073 - "address": "string" ~/~/Адрес АЗС 4074 - } 4065 + "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения 4075 4075 4067 + "ids": [ 4076 4076 4077 - =(%style="color:#000000;font-size:18.6667px"%)Раздел:(%%)**Методыпубличного API для ретрансляторов** =4069 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт 4078 4078 4071 + ], 4079 4079 4080 - ==**Получениеполныхданныхоретрансляторе** ==4073 + "timezone": 0, ~/~/ Часовой пояс 4081 4081 4082 -(% class="box infomessage" %) 4083 -((( 4084 -**GET ** **/api/v3/retranslations/{id}** 4085 -))) 4075 + "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца 4086 4086 4087 -Идентификатор запроса: ID 4088 - 4089 - 4090 -Пример ответа: 4091 - 4092 -{ 4093 -"description": "", ~/~/ Определяет описание 4094 -"subscriberId": "", ~/~/ Подписчик 4095 -"protocolType": 0, ~/~/ Тип протокола 4096 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4097 -"address": "string", ~/~/ Адрес события 4098 -"objects": [ ~/~/Объекты для ретрансляции 4099 -{ 4100 -"id": "", ~/~/ Идентификатор объекта ретрансляции 4101 -"name": "", ~/~/ Наименование объекта ретрансляции 4102 -"imei": "", ~/~/ IMEI объекта 4103 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4104 4104 } 4105 - ], 4106 -"id": "", ~/~/ идентификатор пользователя 4107 -"parentId": "", ~/~/Guid родителя 4108 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4109 -} 4110 4110 4111 - 4112 -== **Удаление данных ретранслятора** == 4113 - 4114 -(% class="box infomessage" %) 4115 -((( 4116 -**DELETE** **/api/v3/retranslations/{id}** 4117 -))) 4118 - 4119 -Параметр запроса: ID 4120 - 4121 - 4122 -== **Создание ретранслятора** == 4123 - 4124 -(% class="box infomessage" %) 4125 -((( 4126 -**POST ** **/api/v3/retranslations/{id}** 4127 -))) 4128 - 4129 -Запрос: 4130 - 4131 -{ 4132 -"description": "", ~/~/ Описание 4133 -"subscriberId": "", ~/~/ Подписчик 4134 -"protocolType": 0, ~/~/ Тип протокола 4135 -"address": "", ~/~/ Адрес ретрансляции 4136 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4137 -"objects": [ ~/~/Объекты для ретрансляции 4138 -{ 4139 -"id": "", ~/~/ идентификатор пользователя 4140 -"imei": "", ~/~/IMEI объекта 4141 -"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4142 -} 4143 - ] 4144 -} 4145 - 4146 - 4147 4147 Ответ: 4148 4148 4149 -{ 4150 -"description": "string", ~/~/ Определяет описание 4151 -"subscriberId": "", ~/~/ идентификатор запроса 4152 -"protocolType": 0, ~/~/ Тип протокола 4153 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4154 -"address": "", ~/~/ Адрес события 4155 -"objects": [ ~/~/Объекты для ретрансляции 4156 -{ 4157 -"id": "", ~/~/ идентификатор пользователя 4158 -"name": "string", ~/~/ Название уведомления 4159 -"imei": "string", ~/~/IMEI объекта 4160 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4161 -} 4162 - ], 4163 -"id": "", ~/~/ идентификатор пользователя 4164 -"parentId": "", ~/~/ Guid идентификатор родителя 4165 -"deleted": true ~/~/ Признак удаления 4166 -} 4081 + { 4167 4167 4083 + "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции 4168 4168 4169 - ==**Редактирование ретранслятора**==4085 + " driver ": "string", ~/~/ Имя водителя 4170 4170 4171 -(% class="box infomessage" %) 4172 -((( 4173 -**PUT** **/api/v3/retranslations** 4174 -))) 4087 + "amount": 0, ~/~/ Количество топлива 4175 4175 4176 - Примерзапроса:4089 + "amountDut": 0, ~/~/ Количество топлива по ДУТ 4177 4177 4178 -{ 4179 -"id": "", ~/~/ идентификатор пользователя 4180 -"description": "string", ~/~/ Определяет описание 4181 -"subscriberId": "", ~/~/ идентификатор запроса 4182 -"protocolType": 0, ~/~/ Тип протокола 4183 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4184 -"address": "string", ~/~/ Адрес события 4185 -"objects": ~/~/Объекты для ретрансляции 4186 -[ 4187 -{ 4188 -"id": "", ~/~/ идентификатор пользователя 4189 -"imei": "", ~/~/IMEI объекта 4190 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4191 -} 4192 - ] 4193 -} 4091 + "amountDiff": 0, ~/~/ Разница в литрах 4194 4194 4093 + "amountDiffPerc": 0, ~/~/ Разница в % 4195 4195 4196 - Примерответа:4095 + "summa": 0, ~/~/ Стоимость в руб. 4197 4197 4198 -{ 4199 -"description": "", ~/~/ Определяет описание 4200 -"subscriberId": "", ~/~/ идентификатор запроса 4201 -"protocolType": 0, ~/~/ Тип протокола 4202 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4203 -"address": "string", ~/~/ Адрес события 4204 -"objects": [ ~/~/Объекты для ретрансляции 4205 -{ 4206 -"id": "", ~/~/ идентификатор пользователя 4207 -"name": "string", ~/~/ Название уведомления 4208 -"imei": "", ~/~/IMEI объекта 4209 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4210 -} 4211 - ], 4212 -"id": "", ~/~/ идентификатор пользователя 4213 -"parentId": "", ~/~/ Guid идентификатор родителя 4214 -"deleted": true ~/~/ Признак удаления 4215 -} 4097 + "serviceName": "string", ~/~/ Тип топлива 4216 4216 4099 + "price": 0, ~/~/ Цена за литр в руб. 4217 4217 4218 - ==**Получениеспискаретранслятораклиента**==4101 + "cardName": "string", ~/~/ Наименование ТК 4219 4219 4220 -(% class="box infomessage" %) 4221 -((( 4222 -**POST /api/v3/retranslations/find** 4223 -))) 4103 + "cardNum": "string", ~/~/ Номер ТК 4224 4224 4225 - Примерзапроса:4105 + "operator": "string", ~/~/ Оператор ТК 4226 4226 4227 -{ 4228 -"id": "", ~/~/ идентификатор пользователя 4229 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4230 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4231 -} 4107 + "address": "string", ~/~/ Адрес АЗС 4232 4232 4233 - Ответ:4109 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid топливной карты 4234 4234 4235 -[ 4236 -{ 4237 -"description": "", ~/~/ Определяет описание 4238 -"subscriberId": "", ~/~/ идентификатор запроса 4239 -"protocolType": 0, ~/~/ Тип протокола 4240 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4241 -"address": "string", ~/~/ Адрес события 4242 -"id": "", ~/~/ идентификатор пользователя 4243 -"parentId": "", ~/~/ Guid идентификатор родителя 4244 -"deleted": true ~/~/ Признак удаления 4245 -} 4246 -] 4247 - 4248 - 4249 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4250 - 4251 -== **API для отчета по выгрузке комбайнов** == 4252 - 4253 -(% class="box infomessage" %) 4254 -((( 4255 -POST **/api/v3/Reports/harvesterUnloading** 4256 -))) 4257 - 4258 -Пример запроса: 4259 - 4260 -{ 4261 - "byTime": 0, ~/~/ Объединение событий по времени 4262 - "byDist": 0, ~/~/ Объединение событий по расстоянию 4263 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4264 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4265 - "showNearestObjects": true, ~/~/Показывать объекты рядом? 4266 - "vehicleIds": [ ~/~/ Список id объектов для анализа 4267 - 0 4268 - ], 4269 - "from": "", ~/~/ Дата и время начало запроса 4270 - "to": "", ~/~/ Дата и время окончания запроса 4271 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4272 -} 4273 - 4274 -Пример ответа: 4275 - 4276 -[ 4277 - { 4278 - "harvesterName": "", ~/~/Комбайн, номер 4279 - "harvesterId": 0, ~/~/Комбайн, id 4280 -"harvesterModel": "", ~/~/ Модель комбайна 4281 -"hopperCapacity": 0, ~/~/ Объем бункера м3 4282 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4283 - "events": [ ~/~/Список событий в разрезе комбайна 4284 - { 4285 - "driverId": "", ~/~/Идентификатор водителя 4286 - "driverName": "", ~/~/Водитель комбайна, ФИО 4287 - "RFID": "", ~/~/ идентификатор карты-метки 4288 - "rfidName": "", ~/~/Водитель комбайна, имя метки 4289 - "vehicleId": 0, ~/~/идентификатор объекта 4290 - "vehicleName": "string", ~/~/ Имя объекта 4291 - "modelName": "string", ~/~/ Имя модели объекта 4292 - "nearestVehicles": [ ~/~/Объекты рядом 4293 - { 4294 - "vehicleId": 0, ~/~/идентификатор объекта 4295 - "vehicleName": "string" ~/~/ Имя объекта 4296 - } 4297 - ], 4298 - "fields": [ ~/~/Поля, где происходила выгрузка 4299 - { 4300 - "id": 0, ~/~/ идентификатор пользователя 4301 - "name": "string" ~/~/ имя пользователя 4302 - } 4303 - ], 4304 - "event": "string", ~/~/Событие 4305 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4306 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4307 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4308 - "cultureName": "string", ~/~/ название культуры 4309 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4310 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4311 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4312 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4313 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4314 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4315 - "issued": 0, ~/~/Выдано, бункеров 4316 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4317 - "latitude": 0, ~/~/Широта 4318 - "longitude": 0, ~/~/ Долгота 4319 - "litresAway": 0, ~/~/Отдано, л 4320 - "m3Away": 0 ~/~/Отдано, м3 4321 - } 4322 - ] 4323 4323 } 4324 -] 4325 4325 4326 4326 4327 - = (% style="color:#000000; font-size:18.6667px" %)Раздел:**Корзина**(%%) =4114 +Раздел: Корзина 4328 4328 4329 - == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==4116 +Запрос на получение списка всех объектов в корзине 4330 4330 4331 - 4332 4332 (% class="box infomessage" %) 4333 4333 ((( 4334 4334 GET api/v3/Vehicles/recyclebin/all ... ... @@ -4342,32 +4342,36 @@ 4342 4342 4343 4343 Ответ: 4344 4344 4345 -[ 4346 - { 4347 - "recordTime": "", ~/~/Время записи 4348 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4349 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4350 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4351 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4352 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4353 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4354 - "items": [ ~/~/ 4355 -nullable: true ~/~/Детали 4356 - { 4357 - "name": "string", ~/~/наименование столбца 4358 - "value": "string" ~/~/содержание столбца 4359 - } 4360 - ] 4361 - }, 4362 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4363 - "string" 4364 - ] 4365 - } 4366 -] 4131 +"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC 4132 +"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект 4133 +"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента 4134 +"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта 4135 +"objectType": "Vehicle", - Тип объекта 4136 +"details": { 4137 +"items": [ { 4138 +"name": "ObjectName", - наименование столбца 4139 +"value": "01" - содержание столбца 4140 +}, 4367 4367 4142 +{ 4143 +"parentName": "string", 4144 +"name": "string", 4145 +"picture": "string", 4146 +"minspeed": 0, 4147 +"maxspeed": 0, 4148 +"width": 0, 4149 +"imbeddedtrailer": true, 4150 +"hoppercapacity": 0, 4151 +"hopperdischargespeed": 0, 4152 +"modelType": 0, 4153 +"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4154 +"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4155 +"deleted": true 4156 +} 4368 4368 4369 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4370 4370 4159 +Запрос на удаление объектов из корзины 4160 + 4371 4371 (% class="box infomessage" %) 4372 4372 ((( 4373 4373 POST/api/v3/Vehicles/recyclebin/erase ... ... @@ -4375,41 +4375,17 @@ 4375 4375 4376 4376 В заголовках запроса: X-Auth: Токен авторизации 4377 4377 4378 -Пример запроса: 4379 - 4168 +Параметры в теле запроса (JSON): 4380 4380 [ 4381 -0 4170 +"eb737fdf-c422-4df7-8727-bd61439b8460", 4171 +"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4382 4382 ] 4383 - 4384 4384 4385 -Пример ответа: 4386 - 4387 -[ 4388 -{ 4389 - "recordTime": "", ~/~/Время записи 4390 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4391 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4392 - "objectId": 0, ~/~/ID объекта, помещённого в корзин 4393 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4394 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4395 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4396 - "items": [ ~/~/Детали 4397 - { 4398 - "name": "", ~/~/Имя свойства 4399 - "value": "" ~/~/Значение свойства 4400 - } 4401 - ] 4402 - }, 4403 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4404 - "" 4405 - ] 4406 - } 4407 -] 4408 - 4409 4409 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4410 4410 4411 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4412 4412 4177 +Запрос на восстановление объектов из корзины 4178 + 4413 4413 (% class="box infomessage" %) 4414 4414 ((( 4415 4415 POST/api/v3/Vehicles/recyclebin/restore ... ... @@ -4418,53 +4418,15 @@ 4418 4418 В заголовках запроса: X-Auth: Токен авторизации 4419 4419 4420 4420 Параметры в теле запроса (JSON): 4421 - 4422 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4423 - 4424 -В заголовках запроса: X-Auth: Токен авторизации 4425 - 4426 - 4427 -Пример запроса: 4428 - 4429 -((( 4430 4430 [ 4431 -))) 4432 - 4433 -((( 4434 - 0 4435 -))) 4436 - 4437 -((( 4188 +"eb737fdf-c422-4df7-8727-bd61439b8460", 4189 +"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4438 4438 ] 4439 -))) 4440 4440 4192 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4441 4441 4442 -Пример ответа: 4443 4443 4444 -[ 4445 -{ 4446 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4447 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4448 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4449 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4450 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4451 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4452 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4453 - "items": [ ~/~/Детали 4454 - { 4455 - "name": "string", ~/~/Имя свойства 4456 - "value": "string" ~/~/Значение свойства 4457 - } 4458 - ] 4459 - }, 4460 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4461 - "string" 4462 - ] 4463 - } 4464 -] 4465 4465 4466 - 4467 - 4468 4468 (% class="box" lang="en-US" style="text-align: center;" %) 4469 4469 ((( 4470 4470 (% 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]] **