<
From version < 153.1 >
edited by Михаил Жучков
on 2024/04/11 08:08
To version < 166.1 >
edited by Андрей Калиновский
on 2024/08/12 16:27
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
1 +XWiki.Gadmin
Content
... ... @@ -16,6 +16,11 @@
16 16  
17 17  (% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 +
20 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
21 +
22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
... ... @@ -44,12 +44,8 @@
44 44  
45 45  (% lang="en-US" %)
46 46  (% style="color:#000000" %){
47 -
48 -(% lang="en-US" %)
49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 - "User": "testuser" , ~/~/ имя пользователя
51 -
52 -(% lang="en-US" %)
52 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
53 + "User": "testuser" , ~/~/ имя пользователя(%%)
53 53  }
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
... ... @@ -229,7 +229,6 @@
229 229   "bankKS": "string" ~/~/ корр. счёт
230 230  }
231 231  
232 -
233 233  Ответ:
234 234  
235 235  {
... ... @@ -423,7 +423,6 @@
423 423   ],
424 424   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
425 425  }
426 -
427 427  {
428 428   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
429 429   "lastName": "string",
... ... @@ -437,12 +437,8 @@
437 437  
438 438  (% style="text-align:left" %)
439 439  (% style="color:#000000; font-weight:normal" %)Ответ:
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 пользователя
439 +{     
440 + "id": "" , ~/~/ ID пользователя
446 446   "lastName": "" , ~/~/ Фамилия ,
447 447   "firstName": "" , ~/~/ Имя
448 448   "position": "" , ~/~/ Должность
... ... @@ -459,11 +459,9 @@
459 459   "kind": "" , ~/~/ тип аутентификации
460 460   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
461 461   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
457 +}
462 462  
463 -(% style="text-align:left" %)
464 -(% style="color:#000000; font-weight:normal" %)}
465 465  
466 -
467 467  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
468 468  
469 469  (% class="box infomessage" %)
... ... @@ -483,19 +483,16 @@
483 483  
484 484  (% style="color:#000000" %)Параметры в теле запроса (JSON):
485 485  
486 -(% style="color:#000000" %){
487 -
479 +(% style="color:#000000" %){(%%)
488 488   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
489 489   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
490 490   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
491 491   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
492 -
493 493  (% style="color:#000000" %)}
494 494  
495 495  (% style="color:#000000" %)Ответ:
496 496  
497 497  (% style="color:#000000" %){         (%%)
498 -
499 499   "id": "" , ~/~/ идентификатор пользователя
500 500   "lastName": "" , ~/~/ фамилия
501 501   "firstName": "" , ~/~/ имя
... ... @@ -509,7 +509,6 @@
509 509   "sessionDuration":"", ~/~/ длительность сессии в минутах
510 510   "status": "1",  ~/~/ статус пользователя
511 511   "lastLogged": "", ~/~/ дата/время последней авторизации
512 -
513 513  (% style="color:#000000" %)}
514 514  
515 515  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -583,10 +583,8 @@
583 583  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
584 584  
585 585  (% lang="en-US" style="text-align:left" %)
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 пользователя 
575 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
576 + "id": "" , ~/~/ ID пользователя 
590 590   "lastName": "" , ~/~/ фамилия
591 591   "firstName": "" , ~/~/ имя
592 592   "position": "" , ~/~/ должность
... ... @@ -608,9 +608,7 @@
608 608   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
609 609   },
610 610   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
611 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
612 -
613 -(% lang="en-US" style="text-align:left" %)
598 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
614 614  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
615 615  
616 616  (% lang="en-US" style="text-align:left" %)
... ... @@ -617,10 +617,8 @@
617 617  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
618 618  
619 619  (% lang="en-US" style="text-align:left" %)
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": "" , ~/~/ идентификатор пользователя
605 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
606 + "id": "" , ~/~/ идентификатор пользователя
624 624   "lastName": "" , ~/~/ фамилия
625 625   "firstName": "" , ~/~/ имя
626 626   "position": "" , ~/~/ должность
... ... @@ -641,10 +641,8 @@
641 641   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
642 642   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
643 643   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
627 +}
644 644  
645 -(% lang="en-US" style="text-align:left" %)
646 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
647 -
648 648  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
649 649  
650 650  (% class="box warningmessage" %)
... ... @@ -664,12 +664,10 @@
664 664  
665 665  (% style="color:#000000" %)Параметры в теле запроса (JSON):
666 666  
667 -(% style="color:#000000" %){
668 -
648 +(% style="color:#000000" %){(%%)
669 669   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
670 670   "description": "" , ~/~/ описание
671 671   "data": "" , ~/~/ данные, связанные со сменой статуса
672 -
673 673  (% style="color:#000000" %)}
674 674  
675 675  (% style="text-align:left" %)
... ... @@ -691,7 +691,7 @@
691 691  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
692 692  
693 693   [ 
694 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
673 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
695 695   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
696 696   ]
697 697  
... ... @@ -1033,19 +1033,15 @@
1033 1033   "deviceTypeName": "", ~/~/ Название типа устройства
1034 1034   "sim1": "", ~/~/ Номер SIM1
1035 1035   "sim2": "", ~/~/ Номер SIM2
1036 -
1037 1037   "parentId": "", ~/~/ ID клиента-родителя
1038 1038   "parentName": "", ~/~/ Наименование клиента-родителя
1039 1039   "modelId": "", ~/~/ ID модели объекта
1040 1040   "modelName": "", ~/~/ Имя модели объекта
1041 -
1042 1042   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1043 1043   "unitName": "string", ~/~/ Наименование подразделения
1044 1044   "status": 0, ~/~/ Статус объекта
1045 -
1046 1046   "createdAt": "", ~/~/ Дата создания объекта
1047 1047   },
1048 -
1049 1049  "customFields": [ ~/~/ Произвольные поля
1050 1050   {
1051 1051   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -1068,8 +1068,7 @@
1068 1068   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1069 1069   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1070 1070   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1071 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
1072 -
1046 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1073 1073   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1074 1074   "mileageCoeff": 0, ~/~/ коэффициент пробега
1075 1075   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -1099,7 +1099,6 @@
1099 1099   "retries": 0 ~/~/ Количество попыток
1100 1100   }
1101 1101   ],
1102 -
1103 1103   "sensors": [ ~/~/ Датчики
1104 1104   {
1105 1105   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -1140,31 +1140,19 @@
1140 1140   },
1141 1141  
1142 1142  ~/~/ Характерные для произвольного:
1143 -
1144 1144  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1145 -
1146 1146  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1147 -
1148 1148  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1149 -
1150 1150  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1151 -
1152 1152  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1153 -
1154 1154  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1155 -
1156 1156  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1157 -
1158 1158  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1159 -
1160 1160  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1161 -
1162 1162  ~/~/ "ValueOn": "Вкл.",
1163 -
1164 1164  ~/~/ "ValueOff": "Выкл."
1165 1165   "summaryMaxValue": 0 ~/~/ Макс. значение
1166 1166   }
1167 -
1168 1168   "drivers": [ ~/~/ Водители
1169 1169   {
1170 1170   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1173,7 +1173,6 @@
1173 1173   "isDefault": true ~/~/ По умолчанию
1174 1174   }
1175 1175   ],
1176 -
1177 1177   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1178 1178   {
1179 1179   "id": "", ~/~/ ID  задания
... ... @@ -1190,8 +1190,7 @@
1190 1190   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1191 1191   }
1192 1192   ],
1193 -
1194 - "statusHistory": [ ~/~/ История статусов
1153 +"statusHistory": [ ~/~/ История статусов
1195 1195   {
1196 1196   "status": 0,
1197 1197   "date": "2023-05-22T09:57:39.562Z",
... ... @@ -1199,7 +1199,6 @@
1199 1199   "additionalInfo": "string"
1200 1200   }
1201 1201   ]
1202 -
1203 1203  }
1204 1204  )))
1205 1205  
... ... @@ -1209,6 +1209,73 @@
1209 1209  (% style="text-align:left" %)
1210 1210  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1211 1211  
1170 +
1171 +== **Отправить команду на терминал** ==
1172 +
1173 +(% class="box successmessage" %)
1174 +(((
1175 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1176 +)))
1177 +
1178 +Команда для отправки на тс.
1179 +
1180 +{  
1181 +"id": "", ~/~/идентификатор произвольного поля
1182 +"command": "", ~/~/ Текст команды
1183 +"retries": "", ~/~/ Количество попыток
1184 +"idTemplate": "" ~/~/ ID шаблона команды
1185 +}
1186 +
1187 +
1188 +== **Получить ответ на отправленную на ТС команду** ==
1189 +
1190 +(% class="box infomessage" %)
1191 +(((
1192 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1193 +)))
1194 +
1195 +Идентификатор команды: cmdid
1196 +
1197 +Запрос от терминала на ответ команды
1198 +
1199 +Пример ответ от терминала:
1200 +
1201 +ID= "" ~/~/ идентификатор произвольного поля
1202 +Soft="" ~/~/ версия софта
1203 +GPS=4 ~/~/ тип трекера
1204 +Time=11:05:43 28.06.24 ~/~/ время запроса
1205 +Lat=45.056221 ~/~/ широта
1206 +Lon=39.035938 ~/~/ долгота
1207 +Speed=0.0 ~/~/ скорость
1208 +Course=181.4 ~/~/направление
1209 +
1210 +(((
1211 +== **Список отправленных объекту команд с ответами** ==
1212 +
1213 +(% class="box infomessage" %)
1214 +(((
1215 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1216 +)))
1217 +
1218 +Идентификатор ТС: vehicleId
1219 +
1220 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1221 +
1222 +Пример ответа терминала
1223 +
1224 +[ 
1225 +{    
1226 +"id": "", ~/~/ идентификатор пользователя
1227 +"commandText": "", ~/~/Текст команды.
1228 +"templateId": "", ~/~/Идентификатор шаблона
1229 +"updated": "", ~/~/ Время отправки  
1230 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1231 +"answer": "", ~/~/ Ответ терминала.
1232 +"status": "" ~/~/ Статус отправки
1233 +}
1234 +]
1235 +)))
1236 +
1212 1212  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1213 1213  
1214 1214  (% class="box successmessage" %)
... ... @@ -1226,8 +1226,7 @@
1226 1226  
1227 1227  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1228 1228  
1229 -(% style="color:#000000" %){
1230 -
1254 +(% style="color:#000000" %){(%%)
1231 1231   "parentId": "" , ~/~/ ID клиента
1232 1232   "name": "" , ~/~/ имя ТС
1233 1233   "imei": "" , ~/~/ IMEI
... ... @@ -1248,7 +1248,6 @@
1248 1248   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1249 1249   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1250 1250   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1251 -
1252 1252   "mileageCalcMethod": 0,
1253 1253   "mileageCoeff": 0,
1254 1254   "locationByCellId": true,
... ... @@ -1281,7 +1281,6 @@
1281 1281   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1282 1282   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1283 1283   }
1284 -
1285 1285  "drivers": [ ~/~/ Водители
1286 1286   {
1287 1287   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1296,8 +1296,7 @@
1296 1296   "retries": 0
1297 1297   }
1298 1298   ],
1299 -
1300 - "sensors": [ ~/~/ Датчики
1321 +"sensors": [ ~/~/ Датчики
1301 1301   {
1302 1302   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1303 1303   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1335,29 +1335,17 @@
1335 1335   "additionalProp2": "string",
1336 1336   "additionalProp3": "string"
1337 1337   },
1338 -
1339 1339  ~/~/ Характерные для произвольного:
1340 -
1341 1341  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1342 -
1343 1343  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1344 -
1345 1345  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1346 -
1347 1347  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1348 -
1349 1349  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1350 -
1351 1351  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1352 -
1353 1353  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1354 -
1355 1355  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1356 -
1357 1357  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1358 -
1359 1359  ~/~/ "ValueOn": "Вкл.",
1360 -
1361 1361  ~/~/ "ValueOff": "Выкл."
1362 1362   "summaryMaxValue": 0 ~/~/ Макс. значение
1363 1363   }
... ... @@ -1376,8 +1376,7 @@
1376 1376  
1377 1377  (% style="color:#000000" %)Ответ:
1378 1378  
1379 -(% style="color:#000000" %){
1380 -
1388 +(% style="color:#000000" %){(%%)
1381 1381   "vehicleId": "", ~/~/ID ТС 
1382 1382   "parentId": "", ~/~/Guid владельца ТС
1383 1383   "name": "", ~/~/Имя объекта
... ... @@ -1415,8 +1415,6 @@
1415 1415   "kind": "", ~/~/ Вид периодичности по времени 
1416 1416   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1417 1417   }
1418 -
1419 -(% style="text-align:left" %)
1420 1420  (% style="color:#000000" %)}
1421 1421  
1422 1422  **Валидация:**
... ... @@ -1475,8 +1475,7 @@
1475 1475  (% style="color:#000000" %)Ответ:
1476 1476  
1477 1477  (% style="color:#000000" %){
1478 -
1479 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1484 + "vehicleId": "" ~/~/ идентификатор объекта
1480 1480   "name": "" ~/~/ наименование объекта
1481 1481   "imei": "" ~/~/ IMEI объекта
1482 1482   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1535,13 +1535,11 @@
1535 1535   "data": "", ~/~/ Данные
1536 1536   "overwrite": false, ~/~/ Флаг перезаписи
1537 1537   "stage": "", ~/~/ Состояние, может быть null
1538 -
1539 1539  (% style="color:#000000" %)}
1540 1540  
1541 1541  (% style="color:#000000" %)Ответ:
1542 1542  
1543 -(% style="color:#000000" %){
1544 -
1547 +(% style="color:#000000" %){(%%)
1545 1545   "status": "", ~/~/ значение статуса
1546 1546   "date": "", ~/~/ Дата смены статуса 
1547 1547   "description": "", ~/~/ Описание
... ... @@ -1548,10 +1548,10 @@
1548 1548   "data": "", ~/~/ Данные
1549 1549   "overwrite": false, ~/~/ Флаг перезаписи
1550 1550   "stage": "", ~/~/ Состояние
1551 -
1552 -(% style="text-align:left" %)
1553 1553  (% style="color:#000000" %) }
1554 1554  
1556 +== ==
1557 +
1555 1555  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1556 1556  
1557 1557  (% class="box warningmessage" %)
... ... @@ -1639,8 +1639,7 @@
1639 1639   "retries": 0
1640 1640   }
1641 1641   ],
1642 -
1643 - "sensors": [ ~/~/ Датчики
1645 +"sensors": [ ~/~/ Датчики
1644 1644   {
1645 1645   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1646 1646   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1678,29 +1678,17 @@
1678 1678   "additionalProp2": "string",
1679 1679   "additionalProp3": "string"
1680 1680   },
1681 -
1682 1682  ~/~/ Характерные для произвольного:
1683 -
1684 1684  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1685 -
1686 1686  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1687 -
1688 1688  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1689 -
1690 1690  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1691 -
1692 1692  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1693 -
1694 1694  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1695 -
1696 1696  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1697 -
1698 1698  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1699 -
1700 1700  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1701 -
1702 1702  ~/~/ "ValueOn": "Вкл.",
1703 -
1704 1704  ~/~/ "ValueOff": "Выкл."
1705 1705   "summaryMaxValue": 0 ~/~/ Макс. значение
1706 1706   }
... ... @@ -1720,9 +1720,7 @@
1720 1720  (% style="color:#000000" %)Ответ:
1721 1721  
1722 1722  (% lang="en-US" style="text-align:left" %)
1723 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1724 -
1725 -(% lang="en-US" style="text-align:left" %)
1713 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1726 1726   "vehicleId": "", ~/~/ ID ТС
1727 1727   "parentId": "", ~/~/ ID клиента
1728 1728   "name": "", ~/~/ имя ТС
... ... @@ -1763,8 +1763,6 @@
1763 1763   "kind": "", ~/~/ Вид периодичности по времени
1764 1764   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1765 1765   }
1766 -
1767 -(% lang="en-US" style="text-align:left" %)
1768 1768  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1769 1769  
1770 1770  **Валидация:**
... ... @@ -1811,12 +1811,9 @@
1811 1811  
1812 1812  (% style="color:#000000" %)Ответ:
1813 1813  
1814 -(% style="color:#000000" %){
1815 -
1800 +(% style="color:#000000" %){(%%)
1816 1816   "deviceTypeId" : "", ~/~/ ID типа устройства
1817 1817   "deviceTypeName" : "" ~/~/ Название типа устройства
1818 -
1819 -(% style="text-align:left" %)
1820 1820  (% style="color:#000000" %)}
1821 1821  
1822 1822  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1838,13 +1838,10 @@
1838 1838  
1839 1839  (% style="color:#000000" %)Ответ:
1840 1840  
1841 -(% style="color:#000000" %){
1842 -
1824 +(% style="color:#000000" %){(%%)
1843 1843   "id": "", ~/~/ ID типа датчика 
1844 1844   "name": "", ~/~/ Название
1845 1845   "description": "", ~/~/ Описание
1846 -
1847 -(% style="text-align:left" %)
1848 1848  (% style="color:#000000" %)}
1849 1849  
1850 1850  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -2161,74 +2161,42 @@
2161 2161  Тело запроса:
2162 2162  
2163 2163  {
2164 -
2165 2165   "vehicleIds": [ ], ~/~/ Список ID объектов
2166 -
2167 2167   "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2168 -
2169 2169   "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2170 -
2171 2171   "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2172 -
2173 2173  }
2174 2174  
2175 2175  Ответ:
2176 2176  
2177 -[
2178 -
2152 +[ 
2179 2179   {
2180 -
2181 2181   "vehicleId": 0, ~/~/ ID объекта
2182 -
2183 2183   "vehicleName": "string", ~/~/ Имя объекта
2184 -
2185 2185   "moves": [ ~/~/ Событие движения
2186 -
2187 2187   {
2188 -
2189 2189   "mileage": 0, ~/~/ Пробег, км
2190 -
2191 2191   "eventId": 0, ~/~/ Идентификатор события
2192 -
2193 2193   "eventName": "string", ~/~/ Название события
2194 -
2195 2195   "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2196 -
2197 2197   "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2198 -
2199 2199   "duration": 0 ~/~/ Продолжительность события, секунд
2200 -
2201 2201   }
2202 -
2203 2203   ],
2204 -
2205 2205   "stops": [ ~/~/ События стоянок
2206 -
2207 2207   {
2208 -
2209 2209   "address": "string", ~/~/ Адрес события
2210 -
2211 2211   "eventId": 0, ~/~/ Идентификатор события
2212 -
2213 2213   "eventName": "string", ~/~/ Название события
2214 -
2215 2215   "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2216 -
2217 2217   "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2218 -
2219 2219   "duration": 0 ~/~/ Продолжительность события, секунд
2220 -
2221 -
2222 2222   }
2223 -
2224 2224   ]
2225 -
2226 2226   }
2227 -
2228 2228  ]
2229 2229  
2230 2230  
2231 -
2232 2232  == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2233 2233  
2234 2234  (% class="box infomessage" %)
... ... @@ -2265,7 +2265,6 @@
2265 2265   }
2266 2266  
2267 2267  
2268 -
2269 2269  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2270 2270  
2271 2271  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2573,6 +2573,23 @@
2573 2573  
2574 2574  Success
2575 2575  
2523 +
2524 +== (% style="color:#000000; font-size:16px" %)**Продление права с определённым идентификатором ids**(%%) ==
2525 +
2526 +(% class="box warningmessage" %)
2527 +(((
2528 +**PUT** /api/v3/notifications/prolongation
2529 +)))
2530 +
2531 +Метод позволяет продлить уведомления.
2532 +
2533 +Метод запроса **PUT**
2534 +
2535 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2536 +
2537 +В заголовках запроса: X-Auth: Токен авторизации
2538 +
2539 +
2576 2576  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2577 2577  
2578 2578  (% class="box errormessage" %)
... ... @@ -3763,7 +3763,7 @@
3763 3763  **POST /api/v3/vehicles/import/{agentId}**
3764 3764  )))
3765 3765  
3766 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3730 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3767 3767  
3768 3768  В пути указывается **agentId** - id клиента.
3769 3769  
... ... @@ -3775,7 +3775,7 @@
3775 3775  
3776 3776  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 3777  |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3778 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3742 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3779 3779  
3780 3780  В теле использовать тип **form-data,** тип значения** file**
3781 3781  
... ... @@ -4052,67 +4052,299 @@
4052 4052  
4053 4053  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4054 4054  
4055 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
4019 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4056 4056  
4057 4057  (% class="box infomessage" %)
4058 4058  (((
4059 -**POST**/api/v3/fuelcards/transactions
4023 +POST /api/v3/fuelcards/transactions
4060 4060  )))
4061 4061  
4062 -Запрос должен содержать параметры:
4026 +Метод запроса: POST
4063 4063  
4028 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4029 +\\В заголовках запроса: X-Auth: Токен авторизации
4030 +
4031 +Параметры в теле запроса (JSON):
4032 +
4064 4064  {
4034 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4035 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4036 + "ids": [ 
4037 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4038 + ],
4039 + "timezone": 0 ~/~/Таймзона
4040 +}
4065 4065  
4066 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
4067 4067  
4068 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
4043 +Ответ:
4044 + {
4045 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4046 + "driver": "string", ~/~/Водители, привязанные к ТК
4047 + "object": "string", ~/~/Наименование ТС
4048 + "amount": 0, ~/~/Количество топлива
4049 + "amountDut": 0, ~/~/Количество по ДУТ
4050 + "amountDiff": 0, ~/~/Разница, л
4051 + "amountDiffPerc": 0, ~/~/Разница, %
4052 + "summa": 0, ~/~/Стоимость, руб
4053 + "serviceName": "string", ~/~/Тип топлива
4054 + "price": 0, ~/~/Цена за литр, руб
4055 + "cardName": "string", ~/~/Наименование ТК
4056 + "cardNum": "string", ~/~/Номер ТК
4057 + "operator": "string", ~/~/Оператор ТК
4058 + "address": "string" ~/~/Адрес АЗС
4059 + }
4069 4069  
4070 - "ids": [
4071 4071  
4072 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
4062 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4073 4073  
4074 - ],
4075 4075  
4076 - "timezone": 0, ~/~/ Часовой пояс
4065 +== **Получение полных данных о ретрансляторе** ==
4077 4077  
4078 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
4067 +(% class="box infomessage" %)
4068 +(((
4069 +**GET ** **/api/v3/retranslations/{id}**
4070 +)))
4079 4079  
4072 +Идентификатор запроса: ID
4073 +
4074 +
4075 +Пример ответа:
4076 +
4077 +{  
4078 +"description": "", ~/~/ Определяет описание
4079 +"subscriberId": "", ~/~/ Подписчик
4080 +"protocolType": 0, ~/~/ Тип протокола
4081 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4082 +"address": "string", ~/~/ Адрес события
4083 +"objects": [ ~/~/Объекты для ретрансляции
4084 +{      
4085 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4086 +"name": "", ~/~/ Наименование объекта ретрансляции
4087 +"imei": "", ~/~/ IMEI объекта  
4088 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4080 4080  }
4090 + ],  
4091 +"id": "", ~/~/ идентификатор пользователя   
4092 +"parentId": "", ~/~/Guid родителя
4093 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4094 +}
4081 4081  
4096 +
4097 +== **Удаление данных ретранслятора** ==
4098 +
4099 +(% class="box infomessage" %)
4100 +(((
4101 +**DELETE** **/api/v3/retranslations/{id}**
4102 +)))
4103 +
4104 +Параметр запроса: ID
4105 +
4106 +
4107 +== **Создание ретранслятора** ==
4108 +
4109 +(% class="box infomessage" %)
4110 +(((
4111 +**POST ** **/api/v3/retranslations/{id}**
4112 +)))
4113 +
4114 +Запрос:
4115 +
4116 +{  
4117 +"description": "", ~/~/ Описание
4118 +"subscriberId": "", ~/~/ Подписчик
4119 +"protocolType": 0, ~/~/ Тип протокола
4120 +"address": "", ~/~/ Адрес ретрансляции
4121 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4122 +"objects": [ ~/~/Объекты для ретрансляции
4123 +{      
4124 +"id": "", ~/~/ идентификатор пользователя     
4125 +"imei": "", ~/~/IMEI объекта
4126 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4127 +}
4128 + ]
4129 +}
4130 +
4131 +
4082 4082  Ответ:
4083 4083  
4084 - {
4134 +{  
4135 +"description": "string", ~/~/ Определяет описание
4136 +"subscriberId": "", ~/~/ идентификатор запроса
4137 +"protocolType": 0, ~/~/ Тип протокола
4138 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4139 +"address": "", ~/~/ Адрес события
4140 +"objects": [ ~/~/Объекты для ретрансляции
4141 +{      
4142 +"id": "", ~/~/ идентификатор пользователя    
4143 +"name": "string", ~/~/ Название уведомления
4144 +"imei": "string", ~/~/IMEI объекта  
4145 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4146 +}
4147 + ],  
4148 +"id": "", ~/~/ идентификатор пользователя  
4149 +"parentId": "", ~/~/ Guid идентификатор родителя
4150 +"deleted": true ~/~/ Признак удаления
4151 +}
4085 4085  
4086 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
4087 4087  
4088 - " driver ": "string", ~/~/ Имя водителя
4154 +== **Редактирование ретранслятора** ==
4089 4089  
4090 - "amount": 0, ~/~/ Количество топлива
4156 +(% class="box infomessage" %)
4157 +(((
4158 +**PUT** **/api/v3/retranslations**
4159 +)))
4091 4091  
4092 - "amountDut": 0, ~/~/ Количество топлива по ДУТ
4161 +Пример запроса:
4093 4093  
4094 - "amountDiff": 0, ~/~/ Разница в литрах
4163 +{  
4164 +"id": "", ~/~/ идентификатор пользователя   
4165 +"description": "string", ~/~/ Определяет описание
4166 +"subscriberId": "", ~/~/ идентификатор запроса
4167 +"protocolType": 0, ~/~/ Тип протокола
4168 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4169 +"address": "string", ~/~/ Адрес события
4170 +"objects": ~/~/Объекты для ретрансляции
4171 +[    
4172 +{      
4173 +"id": "",  ~/~/ идентификатор пользователя         
4174 +"imei": "", ~/~/IMEI объекта
4175 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4176 +}
4177 + ]
4178 +}
4095 4095  
4096 - "amountDiffPerc": 0, ~/~/ Разница в %
4097 4097  
4098 - "summa": 0, ~/~/  Стоимость в руб.
4181 +Пример ответа:
4099 4099  
4100 - "serviceName": "string", ~/~/ Тип топлива
4183 +{  
4184 +"description": "", ~/~/ Определяет описание
4185 +"subscriberId": "", ~/~/ идентификатор запроса
4186 +"protocolType": 0, ~/~/ Тип протокола
4187 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4188 +"address": "string", ~/~/ Адрес события
4189 +"objects": [ ~/~/Объекты для ретрансляции
4190 +{      
4191 +"id": "", ~/~/ идентификатор пользователя     
4192 +"name": "string", ~/~/ Название уведомления    
4193 +"imei": "", ~/~/IMEI объекта
4194 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4195 +}
4196 + ],
4197 +"id": "", ~/~/ идентификатор пользователя   
4198 +"parentId": "", ~/~/ Guid идентификатор родителя
4199 +"deleted": true ~/~/ Признак удаления
4200 +}
4101 4101  
4102 - "price": 0, ~/~/ Цена за литр в руб.
4103 4103  
4104 - "cardName": "string", ~/~/ Наименование ТК
4203 +== **Получение списка ретранслятора клиента** ==
4105 4105  
4106 - "cardNum": "string", ~/~/ Номер ТК
4205 +(% class="box infomessage" %)
4206 +(((
4207 +**POST /api/v3/retranslations/find**
4208 +)))
4107 4107  
4108 - "operator": "string", ~/~/ Оператор ТК
4210 +Пример запроса:
4109 4109  
4110 - "address": "string", ~/~/ Адрес АЗС
4212 +{  
4213 +"id": "", ~/~/ идентификатор пользователя   
4214 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4215 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4216 +}
4111 4111  
4112 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
4218 +Ответ:
4113 4113  
4220 +[ 
4221 +{    
4222 +"description": "", ~/~/ Определяет описание
4223 +"subscriberId": "", ~/~/ идентификатор запроса
4224 +"protocolType": 0, ~/~/ Тип протокола
4225 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4226 +"address": "string", ~/~/ Адрес события
4227 +"id": "", ~/~/ идентификатор пользователя   
4228 +"parentId": "", ~/~/ Guid идентификатор родителя
4229 +"deleted": true ~/~/ Признак удаления
4230 +}
4231 +]
4232 +
4233 +
4234 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4235 +
4236 +== **API для отчета по выгрузке комбайнов** ==
4237 +
4238 +(% class="box infomessage" %)
4239 +(((
4240 +POST **/api/v3/Reports/harvesterUnloading**
4241 +)))
4242 +
4243 +Пример запроса:
4244 +
4245 +{
4246 + "byTime": 0, ~/~/ Объединение событий по времени
4247 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4248 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4249 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4250 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4251 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4252 + 0
4253 + ],
4254 + "from": "", ~/~/ Дата и время начало запроса
4255 + "to": "", ~/~/ Дата и время окончания запроса
4256 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4257 +}
4258 +
4259 +Пример ответа:
4260 +
4261 +[ 
4262 + {
4263 + "harvesterName": "", ~/~/Комбайн, номер
4264 + "harvesterId": 0, ~/~/Комбайн, id
4265 +"harvesterModel": "", ~/~/ Модель комбайна
4266 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4267 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4268 + "events": [ ~/~/Список событий в разрезе комбайна
4269 + {
4270 + "driverId": "", ~/~/Идентификатор водителя
4271 + "driverName": "", ~/~/Водитель комбайна, ФИО
4272 + "RFID": "", ~/~/ идентификатор карты-метки
4273 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4274 + "vehicleId": 0, ~/~/идентификатор объекта
4275 + "vehicleName": "string", ~/~/ Имя объекта
4276 + "modelName": "string", ~/~/ Имя модели объекта
4277 + "nearestVehicles": [ ~/~/Объекты рядом
4278 + {
4279 + "vehicleId": 0, ~/~/идентификатор объекта
4280 + "vehicleName": "string" ~/~/ Имя объекта
4281 + }
4282 + ],
4283 + "fields": [ ~/~/Поля, где происходила выгрузка
4284 + {
4285 + "id": 0, ~/~/ идентификатор пользователя 
4286 + "name": "string" ~/~/ имя пользователя 
4287 + }
4288 + ],
4289 + "event": "string", ~/~/Событие
4290 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4291 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4292 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4293 + "cultureName": "string", ~/~/ название культуры
4294 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4295 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4296 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4297 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4298 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4299 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4300 + "issued": 0, ~/~/Выдано, бункеров
4301 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4302 + "latitude": 0, ~/~/Широта
4303 + "longitude": 0, ~/~/ Долгота
4304 + "litresAway": 0, ~/~/Отдано, л
4305 + "m3Away": 0 ~/~/Отдано, м3
4306 + }
4307 + ]
4114 4114   }
4309 +]
4115 4115  
4311 +
4116 4116  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4117 4117  
4118 4118  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
... ... @@ -4131,32 +4131,29 @@
4131 4131  
4132 4132  Ответ:
4133 4133  
4134 -"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
4135 -"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
4136 -"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
4137 -"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
4138 -"objectType": "Vehicle", - Тип объекта
4139 -"details": {
4140 -"items": [ {
4141 -"name": "ObjectName", - наименование столбца
4142 -"value": "01" - содержание столбца
4143 -},
4330 +[ 
4331 + {
4332 + "recordTime": "", ~/~/Время записи
4333 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4334 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4335 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4336 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4337 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4338 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4339 + "items": [ ~/~/ 
4340 +nullable: true ~/~/Детали
4341 + {
4342 + "name": "string", ~/~/наименование столбца
4343 + "value": "string" ~/~/содержание столбца
4344 + }
4345 + ]
4346 + },
4347 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4348 + "string"
4349 + ]
4350 + }
4351 +]
4144 4144  
4145 -{
4146 -"parentName": "string",
4147 -"name": "string",
4148 -"picture": "string",
4149 -"minspeed": 0,
4150 -"maxspeed": 0,
4151 -"width": 0,
4152 -"imbeddedtrailer": true,
4153 -"hoppercapacity": 0,
4154 -"hopperdischargespeed": 0,
4155 -"modelType": 0,
4156 -"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4157 -"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4158 -"deleted": true
4159 -}
4160 4160  
4161 4161  (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4162 4162  
... ... @@ -4167,12 +4167,37 @@
4167 4167  
4168 4168  В заголовках запроса: X-Auth: Токен авторизации
4169 4169  
4170 -Параметры в теле запроса (JSON):
4363 +Пример запроса:
4364 +
4171 4171  [
4172 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4173 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4366 +0
4174 4174  ]
4368 +
4175 4175  
4370 +Пример ответа:
4371 +
4372 +[ 
4373 +{
4374 + "recordTime": "", ~/~/Время записи
4375 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4376 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4377 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4378 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4379 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4380 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4381 + "items": [ ~/~/Детали
4382 + {
4383 + "name": "", ~/~/Имя свойства
4384 + "value": "" ~/~/Значение свойства
4385 + }
4386 + ]
4387 + },
4388 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4389 + ""
4390 + ]
4391 + }
4392 +]
4393 +
4176 4176  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4177 4177  
4178 4178  == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
... ... @@ -4185,15 +4185,53 @@
4185 4185  В заголовках запроса: X-Auth: Токен авторизации
4186 4186  
4187 4187  Параметры в теле запроса (JSON):
4406 +
4407 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4408 +
4409 +В заголовках запроса: X-Auth: Токен авторизации
4410 +
4411 +
4412 +Пример запроса:
4413 +
4414 +(((
4188 4188  [
4189 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4190 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4416 +)))
4417 +
4418 +(((
4419 + 0
4420 +)))
4421 +
4422 +(((
4191 4191  ]
4424 +)))
4192 4192  
4193 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4194 4194  
4427 +Пример ответа:
4195 4195  
4429 +[
4430 +{
4431 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4432 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4433 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4434 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4435 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4436 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4437 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4438 + "items": [ ~/~/Детали
4439 + {
4440 + "name": "string", ~/~/Имя свойства
4441 + "value": "string" ~/~/Значение свойства
4442 + }
4443 + ]
4444 + },
4445 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4446 + "string"
4447 + ]
4448 + }
4449 +]
4196 4196  
4451 +
4452 +
4197 4197  (% class="box" lang="en-US" style="text-align: center;" %)
4198 4198  (((
4199 4199  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

ГЛОНАССSoft wiki - 2024 г.