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. Gadmin1 +XWiki.SupportZhuchkov - Content
-
... ... @@ -44,12 +44,8 @@ 44 44 45 45 (% lang="en-US" %) 46 46 (% style="color:#000000" %){ 47 - 48 -(% lang="en-US" %) 49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 50 - "User": "testuser" , ~/~/ имя пользователя 51 - 52 -(% lang="en-US" %) 47 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 48 + "User": "testuser" , ~/~/ имя пользователя(%%) 53 53 } 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. ... ... @@ -60,6 +60,9 @@ 60 60 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 61 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 62 59 +(% class="wikigeneratedid" %) 60 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 61 + 63 63 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 64 64 65 65 (% class="box infomessage" %) ... ... @@ -226,7 +226,6 @@ 226 226 "bankKS": "string" ~/~/ корр. счёт 227 227 } 228 228 229 - 230 230 Ответ: 231 231 232 232 { ... ... @@ -420,7 +420,6 @@ 420 420 ], 421 421 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 422 422 } 423 - 424 424 { 425 425 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 426 426 "lastName": "string", ... ... @@ -434,12 +434,8 @@ 434 434 435 435 (% style="text-align:left" %) 436 436 (% style="color:#000000; font-weight:normal" %)Ответ: 437 - 438 -(% style="text-align:left" %) 439 -(% style="color:#000000; font-weight:normal" %){ 440 - 441 -(% style="text-align:left" %) 442 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 434 +{ 435 + "id": "" , ~/~/ ID пользователя 443 443 "lastName": "" , ~/~/ Фамилия , 444 444 "firstName": "" , ~/~/ Имя 445 445 "position": "" , ~/~/ Должность ... ... @@ -456,11 +456,9 @@ 456 456 "kind": "" , ~/~/ тип аутентификации 457 457 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 458 458 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 452 +} 459 459 460 -(% style="text-align:left" %) 461 -(% style="color:#000000; font-weight:normal" %)} 462 462 463 - 464 464 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 465 465 466 466 (% class="box infomessage" %) ... ... @@ -480,19 +480,16 @@ 480 480 481 481 (% style="color:#000000" %)Параметры в теле запроса (JSON): 482 482 483 -(% style="color:#000000" %){ 484 - 474 +(% style="color:#000000" %){(%%) 485 485 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 486 486 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 487 487 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 488 488 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 489 - 490 490 (% style="color:#000000" %)} 491 491 492 492 (% style="color:#000000" %)Ответ: 493 493 494 494 (% style="color:#000000" %){ (%%) 495 - 496 496 "id": "" , ~/~/ идентификатор пользователя 497 497 "lastName": "" , ~/~/ фамилия 498 498 "firstName": "" , ~/~/ имя ... ... @@ -506,7 +506,6 @@ 506 506 "sessionDuration":"", ~/~/ длительность сессии в минутах 507 507 "status": "1", ~/~/ статус пользователя 508 508 "lastLogged": "", ~/~/ дата/время последней авторизации 509 - 510 510 (% style="color:#000000" %)} 511 511 512 512 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -580,10 +580,8 @@ 580 580 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 581 581 582 582 (% lang="en-US" style="text-align:left" %) 583 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 584 - 585 -(% lang="en-US" style="text-align:left" %) 586 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 570 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 + "id": "" , ~/~/ ID пользователя 587 587 "lastName": "" , ~/~/ фамилия 588 588 "firstName": "" , ~/~/ имя 589 589 "position": "" , ~/~/ должность ... ... @@ -605,9 +605,7 @@ 605 605 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 606 606 }, 607 607 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 608 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 609 - 610 -(% lang="en-US" style="text-align:left" %) 593 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 611 611 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 612 612 613 613 (% lang="en-US" style="text-align:left" %) ... ... @@ -614,10 +614,8 @@ 614 614 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 615 615 616 616 (% lang="en-US" style="text-align:left" %) 617 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 618 - 619 -(% lang="en-US" style="text-align:left" %) 620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 600 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 601 + "id": "" , ~/~/ идентификатор пользователя 621 621 "lastName": "" , ~/~/ фамилия 622 622 "firstName": "" , ~/~/ имя 623 623 "position": "" , ~/~/ должность ... ... @@ -638,10 +638,8 @@ 638 638 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 639 639 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 640 640 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 622 +} 641 641 642 -(% lang="en-US" style="text-align:left" %) 643 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 644 - 645 645 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 646 646 647 647 (% class="box warningmessage" %) ... ... @@ -661,12 +661,10 @@ 661 661 662 662 (% style="color:#000000" %)Параметры в теле запроса (JSON): 663 663 664 -(% style="color:#000000" %){ 665 - 643 +(% style="color:#000000" %){(%%) 666 666 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 667 667 "description": "" , ~/~/ описание 668 668 "data": "" , ~/~/ данные, связанные со сменой статуса 669 - 670 670 (% style="color:#000000" %)} 671 671 672 672 (% style="text-align:left" %) ... ... @@ -688,7 +688,7 @@ 688 688 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 689 689 690 690 [ 691 - 668 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 692 692 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 693 693 ] 694 694 ... ... @@ -1030,19 +1030,15 @@ 1030 1030 "deviceTypeName": "", ~/~/ Название типа устройства 1031 1031 "sim1": "", ~/~/ Номер SIM1 1032 1032 "sim2": "", ~/~/ Номер SIM2 1033 - 1034 1034 "parentId": "", ~/~/ ID клиента-родителя 1035 1035 "parentName": "", ~/~/ Наименование клиента-родителя 1036 1036 "modelId": "", ~/~/ ID модели объекта 1037 1037 "modelName": "", ~/~/ Имя модели объекта 1038 - 1039 1039 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1040 1040 "unitName": "string", ~/~/ Наименование подразделения 1041 1041 "status": 0, ~/~/ Статус объекта 1042 - 1043 1043 "createdAt": "", ~/~/ Дата создания объекта 1044 1044 }, 1045 - 1046 1046 "customFields": [ ~/~/ Произвольные поля 1047 1047 { 1048 1048 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1065,8 +1065,7 @@ 1065 1065 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1066 1066 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1067 1067 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1068 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1069 - 1041 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1070 1070 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1071 1071 "mileageCoeff": 0, ~/~/ коэффициент пробега 1072 1072 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1096,7 +1096,6 @@ 1096 1096 "retries": 0 ~/~/ Количество попыток 1097 1097 } 1098 1098 ], 1099 - 1100 1100 "sensors": [ ~/~/ Датчики 1101 1101 { 1102 1102 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1137,31 +1137,19 @@ 1137 1137 }, 1138 1138 1139 1139 ~/~/ Характерные для произвольного: 1140 - 1141 1141 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1142 - 1143 1143 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1144 - 1145 1145 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1146 - 1147 1147 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1148 - 1149 1149 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1150 - 1151 1151 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1152 - 1153 1153 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1154 - 1155 1155 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1156 - 1157 1157 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1158 - 1159 1159 ~/~/ "ValueOn": "Вкл.", 1160 - 1161 1161 ~/~/ "ValueOff": "Выкл." 1162 1162 "summaryMaxValue": 0 ~/~/ Макс. значение 1163 1163 } 1164 - 1165 1165 "drivers": [ ~/~/ Водители 1166 1166 { 1167 1167 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1170,7 +1170,6 @@ 1170 1170 "isDefault": true ~/~/ По умолчанию 1171 1171 } 1172 1172 ], 1173 - 1174 1174 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1175 1175 { 1176 1176 "id": "", ~/~/ ID задания ... ... @@ -1187,8 +1187,7 @@ 1187 1187 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1188 1188 } 1189 1189 ], 1190 - 1191 - "statusHistory": [ ~/~/ История статусов 1148 +"statusHistory": [ ~/~/ История статусов 1192 1192 { 1193 1193 "status": 0, 1194 1194 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1196,7 +1196,6 @@ 1196 1196 "additionalInfo": "string" 1197 1197 } 1198 1198 ] 1199 - 1200 1200 } 1201 1201 ))) 1202 1202 ... ... @@ -1206,6 +1206,73 @@ 1206 1206 (% style="text-align:left" %) 1207 1207 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1208 1208 1165 + 1166 +== **Отправить команду на терминал** == 1167 + 1168 +(% class="box successmessage" %) 1169 +((( 1170 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1171 +))) 1172 + 1173 +Команда для отправки на тс. 1174 + 1175 +{ 1176 +"id": "", ~/~/идентификатор произвольного поля 1177 +"command": "", ~/~/ Текст команды 1178 +"retries": "", ~/~/ Количество попыток 1179 +"idTemplate": "" ~/~/ ID шаблона команды 1180 +} 1181 + 1182 + 1183 +== **Получить ответ на отправленную на ТС команду** == 1184 + 1185 +(% class="box infomessage" %) 1186 +((( 1187 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1188 +))) 1189 + 1190 +Идентификатор команды: cmdid 1191 + 1192 +Запрос от терминала на ответ команды 1193 + 1194 +Пример ответ от терминала: 1195 + 1196 +ID= "" ~/~/ идентификатор произвольного поля 1197 +Soft="" ~/~/ версия софта 1198 +GPS=4 ~/~/ тип трекера 1199 +Time=11:05:43 28.06.24 ~/~/ время запроса 1200 +Lat=45.056221 ~/~/ широта 1201 +Lon=39.035938 ~/~/ долгота 1202 +Speed=0.0 ~/~/ скорость 1203 +Course=181.4 ~/~/направление 1204 + 1205 +((( 1206 +== **Список отправленных объекту команд с ответами** == 1207 + 1208 +(% class="box infomessage" %) 1209 +((( 1210 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1211 +))) 1212 + 1213 +Идентификатор ТС: vehicleId 1214 + 1215 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1216 + 1217 +Пример ответа терминала 1218 + 1219 +[ 1220 +{ 1221 +"id": "", ~/~/ идентификатор пользователя 1222 +"commandText": "", ~/~/Текст команды. 1223 +"templateId": "", ~/~/Идентификатор шаблона 1224 +"updated": "", ~/~/ Время отправки 1225 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1226 +"answer": "", ~/~/ Ответ терминала. 1227 +"status": "" ~/~/ Статус отправки 1228 +} 1229 +] 1230 +))) 1231 + 1209 1209 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1210 1210 1211 1211 (% class="box successmessage" %) ... ... @@ -1223,8 +1223,7 @@ 1223 1223 1224 1224 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1225 1225 1226 -(% style="color:#000000" %){ 1227 - 1249 +(% style="color:#000000" %){(%%) 1228 1228 "parentId": "" , ~/~/ ID клиента 1229 1229 "name": "" , ~/~/ имя ТС 1230 1230 "imei": "" , ~/~/ IMEI ... ... @@ -1245,7 +1245,6 @@ 1245 1245 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1246 1246 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1247 1247 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1248 - 1249 1249 "mileageCalcMethod": 0, 1250 1250 "mileageCoeff": 0, 1251 1251 "locationByCellId": true, ... ... @@ -1278,7 +1278,6 @@ 1278 1278 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1279 1279 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1280 1280 } 1281 - 1282 1282 "drivers": [ ~/~/ Водители 1283 1283 { 1284 1284 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1293,8 +1293,7 @@ 1293 1293 "retries": 0 1294 1294 } 1295 1295 ], 1296 - 1297 - "sensors": [ ~/~/ Датчики 1316 +"sensors": [ ~/~/ Датчики 1298 1298 { 1299 1299 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1300 1300 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1332,29 +1332,17 @@ 1332 1332 "additionalProp2": "string", 1333 1333 "additionalProp3": "string" 1334 1334 }, 1335 - 1336 1336 ~/~/ Характерные для произвольного: 1337 - 1338 1338 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1339 - 1340 1340 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1341 - 1342 1342 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1343 - 1344 1344 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1345 - 1346 1346 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1347 - 1348 1348 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1349 - 1350 1350 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1351 - 1352 1352 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1353 - 1354 1354 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1355 - 1356 1356 ~/~/ "ValueOn": "Вкл.", 1357 - 1358 1358 ~/~/ "ValueOff": "Выкл." 1359 1359 "summaryMaxValue": 0 ~/~/ Макс. значение 1360 1360 } ... ... @@ -1373,8 +1373,7 @@ 1373 1373 1374 1374 (% style="color:#000000" %)Ответ: 1375 1375 1376 -(% style="color:#000000" %){ 1377 - 1383 +(% style="color:#000000" %){(%%) 1378 1378 "vehicleId": "", ~/~/ID ТС 1379 1379 "parentId": "", ~/~/Guid владельца ТС 1380 1380 "name": "", ~/~/Имя объекта ... ... @@ -1412,8 +1412,6 @@ 1412 1412 "kind": "", ~/~/ Вид периодичности по времени 1413 1413 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1414 1414 } 1415 - 1416 -(% style="text-align:left" %) 1417 1417 (% style="color:#000000" %)} 1418 1418 1419 1419 **Валидация:** ... ... @@ -1428,7 +1428,7 @@ 1428 1428 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1429 1429 ))) 1430 1430 1431 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1435 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1432 1432 1433 1433 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1434 1434 ... ... @@ -1472,8 +1472,7 @@ 1472 1472 (% style="color:#000000" %)Ответ: 1473 1473 1474 1474 (% style="color:#000000" %){ 1475 - 1476 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1479 + "vehicleId": "" ~/~/ идентификатор объекта 1477 1477 "name": "" ~/~/ наименование объекта 1478 1478 "imei": "" ~/~/ IMEI объекта 1479 1479 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1532,13 +1532,11 @@ 1532 1532 "data": "", ~/~/ Данные 1533 1533 "overwrite": false, ~/~/ Флаг перезаписи 1534 1534 "stage": "", ~/~/ Состояние, может быть null 1535 - 1536 1536 (% style="color:#000000" %)} 1537 1537 1538 1538 (% style="color:#000000" %)Ответ: 1539 1539 1540 -(% style="color:#000000" %){ 1541 - 1542 +(% style="color:#000000" %){(%%) 1542 1542 "status": "", ~/~/ значение статуса 1543 1543 "date": "", ~/~/ Дата смены статуса 1544 1544 "description": "", ~/~/ Описание ... ... @@ -1545,10 +1545,10 @@ 1545 1545 "data": "", ~/~/ Данные 1546 1546 "overwrite": false, ~/~/ Флаг перезаписи 1547 1547 "stage": "", ~/~/ Состояние 1548 - 1549 -(% style="text-align:left" %) 1550 1550 (% style="color:#000000" %) } 1551 1551 1551 +== == 1552 + 1552 1552 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1553 1553 1554 1554 (% class="box warningmessage" %) ... ... @@ -1636,8 +1636,7 @@ 1636 1636 "retries": 0 1637 1637 } 1638 1638 ], 1639 - 1640 - "sensors": [ ~/~/ Датчики 1640 +"sensors": [ ~/~/ Датчики 1641 1641 { 1642 1642 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1643 1643 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1675,29 +1675,17 @@ 1675 1675 "additionalProp2": "string", 1676 1676 "additionalProp3": "string" 1677 1677 }, 1678 - 1679 1679 ~/~/ Характерные для произвольного: 1680 - 1681 1681 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1682 - 1683 1683 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1684 - 1685 1685 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1686 - 1687 1687 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1688 - 1689 1689 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1690 - 1691 1691 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1692 - 1693 1693 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1694 - 1695 1695 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1696 - 1697 1697 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1698 - 1699 1699 ~/~/ "ValueOn": "Вкл.", 1700 - 1701 1701 ~/~/ "ValueOff": "Выкл." 1702 1702 "summaryMaxValue": 0 ~/~/ Макс. значение 1703 1703 } ... ... @@ -1717,9 +1717,7 @@ 1717 1717 (% style="color:#000000" %)Ответ: 1718 1718 1719 1719 (% lang="en-US" style="text-align:left" %) 1720 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1721 - 1722 -(% lang="en-US" style="text-align:left" %) 1708 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1723 1723 "vehicleId": "", ~/~/ ID ТС 1724 1724 "parentId": "", ~/~/ ID клиента 1725 1725 "name": "", ~/~/ имя ТС ... ... @@ -1760,8 +1760,6 @@ 1760 1760 "kind": "", ~/~/ Вид периодичности по времени 1761 1761 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1762 1762 } 1763 - 1764 -(% lang="en-US" style="text-align:left" %) 1765 1765 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1766 1766 1767 1767 **Валидация:** ... ... @@ -1808,12 +1808,9 @@ 1808 1808 1809 1809 (% style="color:#000000" %)Ответ: 1810 1810 1811 -(% style="color:#000000" %){ 1812 - 1795 +(% style="color:#000000" %){(%%) 1813 1813 "deviceTypeId" : "", ~/~/ ID типа устройства 1814 1814 "deviceTypeName" : "" ~/~/ Название типа устройства 1815 - 1816 -(% style="text-align:left" %) 1817 1817 (% style="color:#000000" %)} 1818 1818 1819 1819 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1835,13 +1835,10 @@ 1835 1835 1836 1836 (% style="color:#000000" %)Ответ: 1837 1837 1838 -(% style="color:#000000" %){ 1839 - 1819 +(% style="color:#000000" %){(%%) 1840 1840 "id": "", ~/~/ ID типа датчика 1841 1841 "name": "", ~/~/ Название 1842 1842 "description": "", ~/~/ Описание 1843 - 1844 -(% style="text-align:left" %) 1845 1845 (% style="color:#000000" %)} 1846 1846 1847 1847 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -2158,74 +2158,42 @@ 2158 2158 Тело запроса: 2159 2159 2160 2160 { 2161 - 2162 2162 "vehicleIds": [ ], ~/~/ Список ID объектов 2163 - 2164 2164 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2165 - 2166 2166 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2167 - 2168 2168 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2169 - 2170 2170 } 2171 2171 2172 2172 Ответ: 2173 2173 2174 -[ 2175 - 2147 +[ 2176 2176 { 2177 - 2178 2178 "vehicleId": 0, ~/~/ ID объекта 2179 - 2180 2180 "vehicleName": "string", ~/~/ Имя объекта 2181 - 2182 2182 "moves": [ ~/~/ Событие движения 2183 - 2184 2184 { 2185 - 2186 2186 "mileage": 0, ~/~/ Пробег, км 2187 - 2188 2188 "eventId": 0, ~/~/ Идентификатор события 2189 - 2190 2190 "eventName": "string", ~/~/ Название события 2191 - 2192 2192 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2193 - 2194 2194 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2195 - 2196 2196 "duration": 0 ~/~/ Продолжительность события, секунд 2197 - 2198 2198 } 2199 - 2200 2200 ], 2201 - 2202 2202 "stops": [ ~/~/ События стоянок 2203 - 2204 2204 { 2205 - 2206 2206 "address": "string", ~/~/ Адрес события 2207 - 2208 2208 "eventId": 0, ~/~/ Идентификатор события 2209 - 2210 2210 "eventName": "string", ~/~/ Название события 2211 - 2212 2212 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2213 - 2214 2214 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2215 - 2216 2216 "duration": 0 ~/~/ Продолжительность события, секунд 2217 - 2218 - 2219 2219 } 2220 - 2221 2221 ] 2222 - 2223 2223 } 2224 - 2225 2225 ] 2226 2226 2227 2227 2228 - 2229 2229 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2230 2230 2231 2231 (% class="box infomessage" %) ... ... @@ -2262,7 +2262,6 @@ 2262 2262 } 2263 2263 2264 2264 2265 - 2266 2266 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2267 2267 2268 2268 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -3760,7 +3760,7 @@ 3760 3760 **POST /api/v3/vehicles/import/{agentId}** 3761 3761 ))) 3762 3762 3763 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3708 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3764 3764 3765 3765 В пути указывается **agentId** - id клиента. 3766 3766 ... ... @@ -3772,7 +3772,7 @@ 3772 3772 3773 3773 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3774 3774 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3775 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1- Замена,2- Слияние,3- Добавление3720 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3776 3776 3777 3777 В теле использовать тип **form-data,** тип значения** file** 3778 3778 ... ... @@ -4049,72 +4049,304 @@ 4049 4049 4050 4050 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4051 4051 4052 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК» 3997 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4053 4053 4054 4054 (% class="box infomessage" %) 4055 4055 ((( 4056 - **POST**/api/v3/fuelcards/transactions4001 +POST /api/v3/fuelcards/transactions 4057 4057 ))) 4058 4058 4059 - Запрос должен содержатьпараметры:4004 +Метод запроса: POST 4060 4060 4006 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4007 +\\В заголовках запроса: X-Auth: Токен авторизации 4008 + 4009 +Параметры в теле запроса (JSON): 4010 + 4061 4061 { 4012 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4013 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4014 + "ids": [ 4015 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4016 + ], 4017 + "timezone": 0 ~/~/Таймзона 4018 +} 4062 4062 4063 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения 4064 4064 4065 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения 4021 +Ответ: 4022 + { 4023 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4024 + "driver": "string", ~/~/Водители, привязанные к ТК 4025 + "object": "string", ~/~/Наименование ТС 4026 + "amount": 0, ~/~/Количество топлива 4027 + "amountDut": 0, ~/~/Количество по ДУТ 4028 + "amountDiff": 0, ~/~/Разница, л 4029 + "amountDiffPerc": 0, ~/~/Разница, % 4030 + "summa": 0, ~/~/Стоимость, руб 4031 + "serviceName": "string", ~/~/Тип топлива 4032 + "price": 0, ~/~/Цена за литр, руб 4033 + "cardName": "string", ~/~/Наименование ТК 4034 + "cardNum": "string", ~/~/Номер ТК 4035 + "operator": "string", ~/~/Оператор ТК 4036 + "address": "string" ~/~/Адрес АЗС 4037 + } 4066 4066 4067 - "ids": [ 4068 4068 4069 - 3fa85f64-5717-4562-b3fc-2c963f66afa6"~/~/Guid-ытопливных карт4040 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4070 4070 4071 - ], 4072 4072 4073 - "timezone":0,~/~/Часовой пояс4043 +== **Получение полных данных о ретрансляторе** == 4074 4074 4075 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца 4045 +(% class="box infomessage" %) 4046 +((( 4047 +**GET ** **/api/v3/retranslations/{id}** 4048 +))) 4076 4076 4050 +Идентификатор запроса: ID 4051 + 4052 + 4053 +Пример ответа: 4054 + 4055 +{ 4056 +"description": "", ~/~/ Определяет описание 4057 +"subscriberId": "", ~/~/ Подписчик 4058 +"protocolType": 0, ~/~/ Тип протокола 4059 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4060 +"address": "string", ~/~/ Адрес события 4061 +"objects": [ ~/~/Объекты для ретрансляции 4062 +{ 4063 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4064 +"name": "", ~/~/ Наименование объекта ретрансляции 4065 +"imei": "", ~/~/ IMEI объекта 4066 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4077 4077 } 4068 + ], 4069 +"id": "", ~/~/ идентификатор пользователя 4070 +"parentId": "", ~/~/Guid родителя 4071 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4072 +} 4078 4078 4074 + 4075 +== **Удаление данных ретранслятора** == 4076 + 4077 +(% class="box infomessage" %) 4078 +((( 4079 +**DELETE** **/api/v3/retranslations/{id}** 4080 +))) 4081 + 4082 +Параметр запроса: ID 4083 + 4084 + 4085 +== **Создание ретранслятора** == 4086 + 4087 +(% class="box infomessage" %) 4088 +((( 4089 +**POST ** **/api/v3/retranslations/{id}** 4090 +))) 4091 + 4092 +Запрос: 4093 + 4094 +{ 4095 +"description": "", ~/~/ Описание 4096 +"subscriberId": "", ~/~/ Подписчик 4097 +"protocolType": 0, ~/~/ Тип протокола 4098 +"address": "", ~/~/ Адрес ретрансляции 4099 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4100 +"objects": [ ~/~/Объекты для ретрансляции 4101 +{ 4102 +"id": "", ~/~/ идентификатор пользователя 4103 +"imei": "", ~/~/IMEI объекта 4104 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4105 +} 4106 + ] 4107 +} 4108 + 4109 + 4079 4079 Ответ: 4080 4080 4081 - { 4112 +{ 4113 +"description": "string", ~/~/ Определяет описание 4114 +"subscriberId": "", ~/~/ идентификатор запроса 4115 +"protocolType": 0, ~/~/ Тип протокола 4116 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4117 +"address": "", ~/~/ Адрес события 4118 +"objects": [ ~/~/Объекты для ретрансляции 4119 +{ 4120 +"id": "", ~/~/ идентификатор пользователя 4121 +"name": "string", ~/~/ Название уведомления 4122 +"imei": "string", ~/~/IMEI объекта 4123 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4124 +} 4125 + ], 4126 +"id": "", ~/~/ идентификатор пользователя 4127 +"parentId": "", ~/~/ Guid идентификатор родителя 4128 +"deleted": true ~/~/ Признак удаления 4129 +} 4082 4082 4083 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции 4084 4084 4085 - " driver ": "string", ~/~/ Имя водителя4132 +== **Редактирование ретранслятора** == 4086 4086 4087 - "amount": 0, ~/~/ Количество топлива 4134 +(% class="box infomessage" %) 4135 +((( 4136 +**PUT** **/api/v3/retranslations** 4137 +))) 4088 4088 4089 - "amountDut": 0, ~/~/ КоличествотопливаДУТ4139 +Пример запроса: 4090 4090 4091 - "amountDiff": 0, ~/~/ Разница в литрах 4141 +{ 4142 +"id": "", ~/~/ идентификатор пользователя 4143 +"description": "string", ~/~/ Определяет описание 4144 +"subscriberId": "", ~/~/ идентификатор запроса 4145 +"protocolType": 0, ~/~/ Тип протокола 4146 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4147 +"address": "string", ~/~/ Адрес события 4148 +"objects": ~/~/Объекты для ретрансляции 4149 +[ 4150 +{ 4151 +"id": "", ~/~/ идентификатор пользователя 4152 +"imei": "", ~/~/IMEI объекта 4153 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4154 +} 4155 + ] 4156 +} 4092 4092 4093 - "amountDiffPerc": 0, ~/~/ Разница в % 4094 4094 4095 - "summa": 0, ~/~/ Стоимостьвруб.4159 +Пример ответа: 4096 4096 4097 - "serviceName": "string", ~/~/ Тип топлива 4161 +{ 4162 +"description": "", ~/~/ Определяет описание 4163 +"subscriberId": "", ~/~/ идентификатор запроса 4164 +"protocolType": 0, ~/~/ Тип протокола 4165 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4166 +"address": "string", ~/~/ Адрес события 4167 +"objects": [ ~/~/Объекты для ретрансляции 4168 +{ 4169 +"id": "", ~/~/ идентификатор пользователя 4170 +"name": "string", ~/~/ Название уведомления 4171 +"imei": "", ~/~/IMEI объекта 4172 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4173 +} 4174 + ], 4175 +"id": "", ~/~/ идентификатор пользователя 4176 +"parentId": "", ~/~/ Guid идентификатор родителя 4177 +"deleted": true ~/~/ Признак удаления 4178 +} 4098 4098 4099 - "price": 0, ~/~/ Цена за литр в руб. 4100 4100 4101 - "cardName": "string", ~/~/ НаименованиеТК4181 +== **Получение списка ретранслятора клиента** == 4102 4102 4103 - "cardNum": "string", ~/~/ Номер ТК 4183 +(% class="box infomessage" %) 4184 +((( 4185 +**POST /api/v3/retranslations/find** 4186 +))) 4104 4104 4105 - "operator": "string", ~/~/ ОператорТК4188 +Пример запроса: 4106 4106 4107 - "address": "string", ~/~/ Адрес АЗС 4190 +{ 4191 +"id": "", ~/~/ идентификатор пользователя 4192 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4193 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4194 +} 4108 4108 4109 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guidтопливной карты4196 +Ответ: 4110 4110 4198 +[ 4199 +{ 4200 +"description": "", ~/~/ Определяет описание 4201 +"subscriberId": "", ~/~/ идентификатор запроса 4202 +"protocolType": 0, ~/~/ Тип протокола 4203 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4204 +"address": "string", ~/~/ Адрес события 4205 +"id": "", ~/~/ идентификатор пользователя 4206 +"parentId": "", ~/~/ Guid идентификатор родителя 4207 +"deleted": true ~/~/ Признак удаления 4208 +} 4209 +] 4210 + 4211 + 4212 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4213 + 4214 +== **API для отчета по выгрузке комбайнов** == 4215 + 4216 +(% class="box infomessage" %) 4217 +((( 4218 +POST **/api/v3/Reports/harvesterUnloading** 4219 +))) 4220 + 4221 +Пример запроса: 4222 + 4223 +{ 4224 + "byTime": 0, ~/~/ Объединение событий по времени 4225 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4226 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4227 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4228 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4229 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4230 + 0 4231 + ], 4232 + "from": "", ~/~/ Дата и время начало запроса 4233 + "to": "", ~/~/ Дата и время окончания запроса 4234 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4235 +} 4236 + 4237 +Пример ответа: 4238 + 4239 +[ 4240 + { 4241 + "harvesterName": "", ~/~/Комбайн, номер 4242 + "harvesterId": 0, ~/~/Комбайн, id 4243 +"harvesterModel": "", ~/~/ Модель комбайна 4244 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4245 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4246 + "events": [ ~/~/Список событий в разрезе комбайна 4247 + { 4248 + "driverId": "", ~/~/Идентификатор водителя 4249 + "driverName": "", ~/~/Водитель комбайна, ФИО 4250 + "RFID": "", ~/~/ идентификатор карты-метки 4251 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4252 + "vehicleId": 0, ~/~/идентификатор объекта 4253 + "vehicleName": "string", ~/~/ Имя объекта 4254 + "modelName": "string", ~/~/ Имя модели объекта 4255 + "nearestVehicles": [ ~/~/Объекты рядом 4256 + { 4257 + "vehicleId": 0, ~/~/идентификатор объекта 4258 + "vehicleName": "string" ~/~/ Имя объекта 4259 + } 4260 + ], 4261 + "fields": [ ~/~/Поля, где происходила выгрузка 4262 + { 4263 + "id": 0, ~/~/ идентификатор пользователя 4264 + "name": "string" ~/~/ имя пользователя 4265 + } 4266 + ], 4267 + "event": "string", ~/~/Событие 4268 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4269 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4270 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4271 + "cultureName": "string", ~/~/ название культуры 4272 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4273 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4274 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4275 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4276 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4277 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4278 + "issued": 0, ~/~/Выдано, бункеров 4279 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4280 + "latitude": 0, ~/~/Широта 4281 + "longitude": 0, ~/~/ Долгота 4282 + "litresAway": 0, ~/~/Отдано, л 4283 + "m3Away": 0 ~/~/Отдано, м3 4284 + } 4285 + ] 4111 4111 } 4287 +] 4112 4112 4113 4113 4114 -Раздел: Корзина 4290 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4115 4115 4116 -Запрос на получение списка всех объектов в корзине 4292 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4117 4117 4294 + 4118 4118 (% class="box infomessage" %) 4119 4119 ((( 4120 4120 GET api/v3/Vehicles/recyclebin/all ... ... @@ -4128,36 +4128,32 @@ 4128 4128 4129 4129 Ответ: 4130 4130 4131 -"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC 4132 -"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект 4133 -"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента 4134 -"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта 4135 -"objectType": "Vehicle", - Тип объекта 4136 -"details": { 4137 -"items": [ { 4138 -"name": "ObjectName", - наименование столбца 4139 -"value": "01" - содержание столбца 4140 -}, 4308 +[ 4309 + { 4310 + "recordTime": "", ~/~/Время записи 4311 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4312 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4313 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4314 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4315 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4316 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4317 + "items": [ ~/~/ 4318 +nullable: true ~/~/Детали 4319 + { 4320 + "name": "string", ~/~/наименование столбца 4321 + "value": "string" ~/~/содержание столбца 4322 + } 4323 + ] 4324 + }, 4325 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4326 + "string" 4327 + ] 4328 + } 4329 +] 4141 4141 4142 -{ 4143 -"parentName": "string", 4144 -"name": "string", 4145 -"picture": "string", 4146 -"minspeed": 0, 4147 -"maxspeed": 0, 4148 -"width": 0, 4149 -"imbeddedtrailer": true, 4150 -"hoppercapacity": 0, 4151 -"hopperdischargespeed": 0, 4152 -"modelType": 0, 4153 -"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4154 -"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4155 -"deleted": true 4156 -} 4157 4157 4332 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4158 4158 4159 -Запрос на удаление объектов из корзины 4160 - 4161 4161 (% class="box infomessage" %) 4162 4162 ((( 4163 4163 POST/api/v3/Vehicles/recyclebin/erase ... ... @@ -4165,17 +4165,41 @@ 4165 4165 4166 4166 В заголовках запроса: X-Auth: Токен авторизации 4167 4167 4168 -Параметры в теле запроса (JSON): 4341 +Пример запроса: 4342 + 4169 4169 [ 4170 -"eb737fdf-c422-4df7-8727-bd61439b8460", 4171 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4344 +0 4172 4172 ] 4346 + 4173 4173 4174 - Ответ: В случае успешного выполнения запроса вернетсяHTTPответ«200».4348 +Пример ответа: 4175 4175 4350 +[ 4351 +{ 4352 + "recordTime": "", ~/~/Время записи 4353 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4354 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4355 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4356 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4357 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4358 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4359 + "items": [ ~/~/Детали 4360 + { 4361 + "name": "", ~/~/Имя свойства 4362 + "value": "" ~/~/Значение свойства 4363 + } 4364 + ] 4365 + }, 4366 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4367 + "" 4368 + ] 4369 + } 4370 +] 4176 4176 4177 - Запроснавосстановлениеобъектовизкорзины4372 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4178 4178 4374 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4375 + 4179 4179 (% class="box infomessage" %) 4180 4180 ((( 4181 4181 POST/api/v3/Vehicles/recyclebin/restore ... ... @@ -4184,15 +4184,53 @@ 4184 4184 В заголовках запроса: X-Auth: Токен авторизации 4185 4185 4186 4186 Параметры в теле запроса (JSON): 4384 + 4385 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4386 + 4387 +В заголовках запроса: X-Auth: Токен авторизации 4388 + 4389 + 4390 +Пример запроса: 4391 + 4392 +((( 4187 4187 [ 4188 -"eb737fdf-c422-4df7-8727-bd61439b8460", 4189 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4394 +))) 4395 + 4396 +((( 4397 + 0 4398 +))) 4399 + 4400 +((( 4190 4190 ] 4402 +))) 4191 4191 4192 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4193 4193 4405 +Пример ответа: 4194 4194 4407 +[ 4408 +{ 4409 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4410 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4411 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4412 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4413 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4414 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4415 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4416 + "items": [ ~/~/Детали 4417 + { 4418 + "name": "string", ~/~/Имя свойства 4419 + "value": "string" ~/~/Значение свойства 4420 + } 4421 + ] 4422 + }, 4423 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4424 + "string" 4425 + ] 4426 + } 4427 +] 4195 4195 4429 + 4430 + 4196 4196 (% class="box" lang="en-US" style="text-align: center;" %) 4197 4197 ((( 4198 4198 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **