Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
<
>
edited by Андрей Калиновский
on 2024/03/18 11:34
on 2024/03/18 11:34
edited by Андрей Калиновский
on 2024/10/30 14:07
on 2024/10/30 14:07
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -14,11 +14,20 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 + 20 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 21 + 22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 23 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 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 +))) 22 22 23 23 (% class="box successmessage" %) 24 24 ((( ... ... @@ -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" %) 56 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 57 + "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 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 + 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 пользователя 443 +{ 444 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 461 +} 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 - 483 +(% 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 пользователя 579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 580 + "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" %) 602 + "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": "" , ~/~/ идентификатор пользователя 609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 610 + "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» названия группы пользователя 631 +} 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 - 652 +(% 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 - 677 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 692 692 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 693 693 ] 694 694 ... ... @@ -994,7 +994,7 @@ 994 994 995 995 Ответ: В случае успеха **Success 200** 996 996 997 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 998 998 999 999 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 1000 1000 ... ... @@ -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 - 1050 + "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": [ ~/~/ История статусов 1157 +"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 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 + 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 - 1258 +(% 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": [ ~/~/ Датчики 1325 +"sensors": [ ~/~/ Датчики 1298 1298 { 1299 1299 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1300 1300 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1332,33 +1332,25 @@ 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 } 1361 1361 ], 1378 + 1379 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1380 + 1381 + 1362 1362 "customFields": [ ~/~/ Произвольные поля 1363 1363 { 1364 1364 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1373,55 +1373,157 @@ 1373 1373 1374 1374 (% style="color:#000000" %)Ответ: 1375 1375 1376 -(% style="color:#000000" %){ 1377 1377 1378 - "vehicleId": "", ~/~/ID ТС 1379 - "parentId": "", ~/~/Guid владельца ТС 1380 - "name": "", ~/~/Имя объекта 1381 - "imei": "", ~/~/IMEI 1382 - "deviceTypeId": "", ~/~/ID типа устройства 1383 - "modelId": "", ~/~/ID модели 1384 - "unitId": "", ~/~/ID подразделения 1385 - "sim1": "", ~/~/SIM1 1386 - "sim2": "", ~/~/SIM2 1387 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1388 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1389 - "counters": { ~/~/Счётчики 1390 - "mileageEnabled": true, 1391 - "motohoursEnabled": true, 1392 - "mileage": "", 1393 - "motohours": 345.0 1394 - }, 1395 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1396 - "id": null, 1397 - "enabled": true, ~/~/флаг включения 1398 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1399 - "login": "", ~/~/ имя учетной записи 1400 - "password": "" ~/~/ пароль учетной записи 1401 - }, 1402 - "inspectionTasks": { ~/~/ задания на ТО 1403 - "id": "", ~/~/ ID задачи 1404 - "enabled": false, ~/~/ Признак включения 1405 - "name": "", ~/~/ Имя задания 1406 - "description": "", ~/~/ Описание задания 1407 - "mileageCondition": "", ~/~/ Условие по пробегу 1408 - "lastMileage": "", ~/~/ Пробег (в метрах) 1409 - "motohoursCondition": "", ~/~/ Условие по моточасам 1410 - "lastMotohours": "", ~/~/ Моточасы 1411 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1412 - "kind": "", ~/~/ Вид периодичности по времени 1413 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1397 +((( 1398 +((( 1399 +{ 1400 + "vehicleId": 0, ~/~/ ID ТС 1401 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1402 + "name": "string", ~/~/ Имя объекта 1403 + "imei": "string", ~/~/ IMEI 1404 + "deviceTypeId": 0, ~/~/ ID типа устройства 1405 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1406 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1407 + "sim1": "string", ~/~/ SIM1 1408 + "sim2": "string", ~/~/ SIM2 1409 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1410 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1411 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1412 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1413 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1414 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1415 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1416 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1417 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1418 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1419 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1420 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1421 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1422 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1423 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1424 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1425 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1426 + "counters": { ~/~/ Dto для состояний счётчиков 1427 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1428 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1429 + "mileage": 0, ~/~/ Пробег 1430 + "motohours": 0 ~/~/ Моточасы 1431 + }, 1432 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1433 + "id": "string", ~/~/ CMSV6 Идентификатор 1434 + "enabled": true, ~/~/ Признак включения 1435 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1436 + "login": "string", ~/~/ CMSV6 имя учетной записи 1437 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1438 + }, 1439 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1440 + { 1441 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1442 + "enabled": true, ~/~/ Признак включения 1443 + "name": "string", ~/~/ Имя задания 1444 + "description": "string", ~/~/ Описание задания 1445 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1446 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1447 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1448 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1449 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1450 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1451 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1452 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1414 1414 } 1454 + ], 1455 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1456 + { 1457 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1458 + "inputNumber": 0, ~/~/ № входа. 1459 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1460 + "comment": "string", ~/~/ Комментарий 1461 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1462 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1463 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1464 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1465 + } 1466 + ], 1467 + "commandTemplates": [ ~/~/ Список шаблонов команд 1468 + { 1469 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1470 + "name": "string", ~/~/ Название шаблона команд 1471 + "command": "string", ~/~/ Команда на выполнение 1472 + "retries": 0 ~/~/ Лимит попыток отправки 1473 + } 1474 + ], 1475 + "sensors": [ ~/~/ Список датчиков 1476 + { 1477 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1478 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1479 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1480 + "name": "string", ~/~/ Имя датчика 1481 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1482 + "inputNumber": 0, ~/~/ Номер входа 1483 + "pseudonym": "string", ~/~/ Псевдоним 1484 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1485 + "isInverted": true, ~/~/ Признак инверсии 1486 + "disabled": true, ~/~/ Датчик не участвует в обработке 1487 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1488 + "gradesTables": [ ~/~/ Тарировка 1489 + { 1490 + "grades": [ ~/~/ Таблицы тарировки 1491 + { 1492 + "input": 0, ~/~/ Вход 1493 + "output": 0 ~/~/ Выход 1494 + } 1495 + ], 1496 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1497 + } 1498 + ], 1499 + "showInTooltip": true, ~/~/ Отображение в подсказке 1500 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1501 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1502 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1503 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1504 + "expr": "string", ~/~/ Выражение 1505 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1506 + "string" 1507 + ], 1508 + "customParams": { 1509 + "additionalProp1": "string", 1510 + "additionalProp2": "string", 1511 + "additionalProp3": "string" 1512 + }, 1513 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1514 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1515 + { 1516 + "from": 0, ~/~/ С какого значения 1517 + "color": "string", ~/~/ Каким цветом 1518 + (% style="background-color:inherit; color:inherit; font-family:Menlo,Monaco,Consolas,~"Courier New~",monospace; font-size:inherit; white-space:pre" %)"text": "string" 1519 +))) 1415 1415 1416 -(% style="text-align:left" %) 1417 -(% style="color:#000000" %)} 1521 + } 1522 + ] 1523 + } 1524 + ], 1525 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1526 + "customFields": [ ~/~/ Список произвольных полей 1527 + { 1528 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1529 + "name": "string", ~/~/ Наименование произвольного поля 1530 + "value": "string", ~/~/ Значение произвольного поля 1531 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1532 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1533 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1534 + } 1535 + ], 1536 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1537 +} 1538 +))) 1418 1418 1540 + 1419 1419 **Валидация:** 1420 1420 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1421 1421 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1422 1422 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1423 1423 1424 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1546 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1425 1425 1426 1426 (% class="box infomessage" %) 1427 1427 ((( ... ... @@ -1428,7 +1428,7 @@ 1428 1428 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1429 1429 ))) 1430 1430 1431 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1553 +(% 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": "" ~/~/ идентификатор объекта 1597 + "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 - 1660 +(% 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 1669 +== == 1670 + 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": [ ~/~/ Датчики 1758 +"sensors": [ ~/~/ Датчики 1641 1641 { 1642 1642 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1643 1643 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1675,33 +1675,26 @@ 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 } 1704 1704 ], 1811 + 1812 +((( 1813 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1814 +))) 1815 + 1705 1705 "customFields": [ ~/~/ Произвольные поля 1706 1706 { 1707 1707 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1716,54 +1716,175 @@ 1716 1716 1717 1717 (% style="color:#000000" %)Ответ: 1718 1718 1719 -(% lang="en-US" style="text-align:left" %) 1720 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1830 +((( 1831 +{ 1832 + "vehicleId": 0, ~/~/ ID ТС 1833 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1834 + "name": "string", ~/~/ Имя объекта 1835 + "imei": "string", ~/~/ IMEI 1836 + "deviceTypeId": 0, ~/~/ ID типа устройства 1837 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1838 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1839 + "sim1": "string", ~/~/ SIM1 1840 + "sim2": "string", ~/~/ SIM2 1841 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1842 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1843 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1844 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1845 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1846 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1847 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1848 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1849 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1850 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1851 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1852 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1853 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1854 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1855 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1856 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1857 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1858 + "counters": { ~/~/ состояний счётчиков 1859 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1860 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1861 + "mileage": 0, ~/~/ Пробег 1862 + "motohours": 0 ~/~/ Моточасы 1863 + }, 1864 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1865 + "id": "string", ~/~/ CMSV6 Идентификатор 1866 + "enabled": true, ~/~/ Признак включения 1867 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1868 +))) 1721 1721 1722 -(% lang="en-US" style="text-align:left" %) 1723 - "vehicleId": "", ~/~/ ID ТС 1724 - "parentId": "", ~/~/ ID клиента 1725 - "name": "", ~/~/ имя ТС 1726 - "imei": "", ~/~/ IMEI 1727 - "deviceTypeId": "", ~/~/ типа устройства 1728 - "modelId": "", ~/~/ ID модели 1729 - "unitId": "", ~/~/ ID подразделения 1730 - "sim1": "", ~/~/ SIM 1 1731 - "sim2": "", ~/~/ SIM2 1732 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1733 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1734 - "counters": 1735 - { 1736 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1737 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1738 - "mileage": "", ~/~/ пробег 1739 - "motohours": "", ~/~/ моточасы 1740 - } 1741 - "cmsv6Parameters": ~/~/ параметры CMSv6 1870 + 1871 +((( 1872 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1873 + "login": "string", ~/~/ CMSV6 имя учетной записи 1874 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1875 + }, 1876 + "inspectionTasks": [ ~/~/ Задания на ТО 1877 + { 1878 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1879 + "enabled": true, ~/~/ Признак включения 1880 + "name": "string", ~/~/ Имя задания 1881 + "description": "string", ~/~/ Описание задания 1882 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1883 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1884 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1885 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1886 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1887 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 1888 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 1889 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1890 + } 1891 + ], 1892 + "drivers": [ ~/~/ Список водителей 1893 + { 1894 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1895 + "inputNumber": 0, ~/~/ № входа. 1896 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 1897 + "comment": "string", ~/~/ Комментарий. 1898 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1899 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1900 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 1901 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 1902 + } 1903 + ], 1904 + "commandTemplates": [ ~/~/ Список шаблонов команд 1905 + { 1906 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1907 + "name": "string", ~/~/ Название шаблона команд 1908 + "command": "string", ~/~/ Команда на выполнение 1909 + "retries": 0 ~/~/ Лимит попыток отправки 1910 + } 1911 + ], 1912 + "sensors": [ ~/~/ Список датчиков 1913 + { 1914 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1915 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1916 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 1917 +))) 1918 + 1919 +((( 1920 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 1921 +))) 1922 + 1923 +((( 1924 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 1925 +))) 1926 + 1927 +((( 1928 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 1929 +))) 1930 + 1931 +((( 1932 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 1933 +))) 1934 + 1935 +((( 1936 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1937 + "name": "string", ~/~/ Имя датчика 1938 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 1939 +))) 1940 + 1941 +((( 1942 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1943 + "inputNumber": 0, ~/~/ Номер входа 1944 + "pseudonym": "string", ~/~/ Псевдоним 1945 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1946 + "isInverted": true, ~/~/ Признак инверсии 1947 + "disabled": true, ~/~/ Датчик не участвует в обработке 1948 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1949 + "gradesTables": [ ~/~/ Тарировка 1742 1742 { 1743 - "id": ~/~/ идентификатор 1744 - "enabled": true, ~/~/ флаг включения 1745 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1746 - "login": "", ~/~/ имя учетной записи 1747 - "password": "", ~/~/ пароль учетной записи 1748 - } 1749 - "inspectionTasks": ~/~/ задания на ТО 1951 + "grades": [ ~/~/ Таблицы тарировки 1952 + { 1953 + "input": 0, ~/~/ Вход 1954 + "output": 0 ~/~/ Выход 1955 + } 1956 + ], 1957 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1958 + } 1959 + ], 1960 + "showInTooltip": true, ~/~/ Отображение в подсказке 1961 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1962 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1963 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1964 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1965 + "expr": "string", ~/~/ Выражение 1966 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1967 + "string" 1968 + ], 1969 + "customParams": { ~/~/ Дополнительные настройки 1970 + "additionalProp1": "string", 1971 + "additionalProp2": "string", 1972 + "additionalProp3": "string" 1973 + }, 1974 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1975 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1750 1750 { 1751 - "id": "", ~/~/ ID задания 1752 - "enabled": false, ~/~/ Признак включения 1753 - "name": "", ~/~/ Имя задания 1754 - "description": "", ~/~/ Описание задания 1755 - "mileageCondition": "", ~/~/ Условие по пробегу 1756 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1757 - "motohoursCondition": "", ~/~/ Условие по моточасам 1758 - "lastMotohours": "", ~/~/ Моточасы 1759 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1760 - "kind": "", ~/~/ Вид периодичности по времени 1761 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1977 + "from": 0, ~/~/ С какого значения 1978 + "color": "string", ~/~/ Каким цветом 1979 + "text": "string" ~/~/ Текст подписи к этому интервалу 1762 1762 } 1981 + ] 1982 + } 1983 + ], 1984 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1985 + "customFields": [ ~/~/ Список произвольных полей 1986 + { 1987 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1988 + "name": "string", ~/~/ Наименование произвольного поля 1989 + "value": "string", ~/~/ Значение произвольного поля 1990 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1991 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1992 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1993 + } 1994 + ], 1995 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1996 +} 1997 +))) 1763 1763 1764 -(% lang="en-US" style="text-align:left" %) 1765 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1766 - 1767 1767 **Валидация:** 1768 1768 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1769 1769 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1808,12 +1808,9 @@ 1808 1808 1809 1809 (% style="color:#000000" %)Ответ: 1810 1810 1811 -(% style="color:#000000" %){ 1812 - 2043 +(% 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 - 2067 +(% 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" %)Раздел: **Сообщения**(%%) = ... ... @@ -2043,10 +2043,12 @@ 2043 2043 { 2044 2044 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2045 2045 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2046 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2047 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2048 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2049 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2272 + "mileage": 0, ~/~/ Пробег за период, километры 2273 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2274 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2275 + "motohours": 0, ~/~/ Моточасы за период, секунды 2276 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2277 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2050 2050 } 2051 2051 ] 2052 2052 } ... ... @@ -2095,6 +2095,12 @@ 2095 2095 } 2096 2096 ] 2097 2097 2326 +(% class="box warningmessage" %) 2327 +((( 2328 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2329 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2330 +))) 2331 + 2098 2098 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2099 2099 2100 2100 (% class="box infomessage" %) ... ... @@ -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 - 2403 +[ 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" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2570,6 +2570,32 @@ 2570 2570 2571 2571 Success 2572 2572 2774 + 2775 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2776 + 2777 +(% class="box warningmessage" %) 2778 +((( 2779 +**PUT** /api/v3/notifications/prolongation 2780 +))) 2781 + 2782 +Метод позволяет продлить уведомления. 2783 + 2784 +Метод запроса **PUT** 2785 + 2786 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2787 + 2788 +В заголовках запроса: X-Auth: Токен авторизации. 2789 + 2790 +Тело запроса: 2791 + 2792 +[ 2793 + 2794 +0 2795 + 2796 +] 2797 + 2798 +где 0 идентификатор ids. 2799 + 2573 2573 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2574 2574 2575 2575 (% class="box errormessage" %) ... ... @@ -3760,7 +3760,7 @@ 3760 3760 **POST /api/v3/vehicles/import/{agentId}** 3761 3761 ))) 3762 3762 3763 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3990 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **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- Добавление4002 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3776 3776 3777 3777 В теле использовать тип **form-data,** тип значения** file** 3778 3778 ... ... @@ -4034,7 +4034,7 @@ 4034 4034 |dangerousDrivingViolations|Резкое вождение 4035 4035 |sensorViolations|Нарушение по датчику 4036 4036 |moveTime|Время в движении 4037 -|mileage|Пробег 4264 +|mileage|Пробег (км) 4038 4038 |tripsCount|Количество рейсов 4039 4039 |motohours|Моточасы 4040 4040 |maxSpeed|Максимальная скорость ... ... @@ -4049,67 +4049,299 @@ 4049 4049 4050 4050 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4051 4051 4052 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК» 4279 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4053 4053 4054 4054 (% class="box infomessage" %) 4055 4055 ((( 4056 - **POST**/api/v3/fuelcards/transactions4283 +POST /api/v3/fuelcards/transactions 4057 4057 ))) 4058 4058 4059 - Запрос должен содержатьпараметры:4286 +Метод запроса: POST 4060 4060 4288 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4289 +\\В заголовках запроса: X-Auth: Токен авторизации 4290 + 4291 +Параметры в теле запроса (JSON): 4292 + 4061 4061 { 4294 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4295 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4296 + "ids": [ 4297 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4298 + ], 4299 + "timezone": 0 ~/~/Таймзона 4300 +} 4062 4062 4063 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения 4064 4064 4065 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения 4303 +Ответ: 4304 + { 4305 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4306 + "driver": "string", ~/~/Водители, привязанные к ТК 4307 + "object": "string", ~/~/Наименование ТС 4308 + "amount": 0, ~/~/Количество топлива 4309 + "amountDut": 0, ~/~/Количество по ДУТ 4310 + "amountDiff": 0, ~/~/Разница, л 4311 + "amountDiffPerc": 0, ~/~/Разница, % 4312 + "summa": 0, ~/~/Стоимость, руб 4313 + "serviceName": "string", ~/~/Тип топлива 4314 + "price": 0, ~/~/Цена за литр, руб 4315 + "cardName": "string", ~/~/Наименование ТК 4316 + "cardNum": "string", ~/~/Номер ТК 4317 + "operator": "string", ~/~/Оператор ТК 4318 + "address": "string" ~/~/Адрес АЗС 4319 + } 4066 4066 4067 - "ids": [ 4068 4068 4069 - 3fa85f64-5717-4562-b3fc-2c963f66afa6"~/~/Guid-ытопливных карт4322 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4070 4070 4071 - ], 4072 4072 4073 - "timezone":0,~/~/Часовой пояс4325 +== **Получение полных данных о ретрансляторе** == 4074 4074 4075 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца 4327 +(% class="box infomessage" %) 4328 +((( 4329 +**GET ** **/api/v3/retranslations/{id}** 4330 +))) 4076 4076 4332 +Идентификатор запроса: ID 4333 + 4334 + 4335 +Пример ответа: 4336 + 4337 +{ 4338 +"description": "", ~/~/ Определяет описание 4339 +"subscriberId": "", ~/~/ Подписчик 4340 +"protocolType": 0, ~/~/ Тип протокола 4341 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4342 +"address": "string", ~/~/ Адрес события 4343 +"objects": [ ~/~/Объекты для ретрансляции 4344 +{ 4345 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4346 +"name": "", ~/~/ Наименование объекта ретрансляции 4347 +"imei": "", ~/~/ IMEI объекта 4348 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4077 4077 } 4350 + ], 4351 +"id": "", ~/~/ идентификатор пользователя 4352 +"parentId": "", ~/~/Guid родителя 4353 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4354 +} 4078 4078 4356 + 4357 +== **Удаление данных ретранслятора** == 4358 + 4359 +(% class="box infomessage" %) 4360 +((( 4361 +**DELETE** **/api/v3/retranslations/{id}** 4362 +))) 4363 + 4364 +Параметр запроса: ID 4365 + 4366 + 4367 +== **Создание ретранслятора** == 4368 + 4369 +(% class="box infomessage" %) 4370 +((( 4371 +**POST ** **/api/v3/retranslations/{id}** 4372 +))) 4373 + 4374 +Запрос: 4375 + 4376 +{ 4377 +"description": "", ~/~/ Описание 4378 +"subscriberId": "", ~/~/ Подписчик 4379 +"protocolType": 0, ~/~/ Тип протокола 4380 +"address": "", ~/~/ Адрес ретрансляции 4381 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4382 +"objects": [ ~/~/Объекты для ретрансляции 4383 +{ 4384 +"id": "", ~/~/ идентификатор пользователя 4385 +"imei": "", ~/~/IMEI объекта 4386 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4387 +} 4388 + ] 4389 +} 4390 + 4391 + 4079 4079 Ответ: 4080 4080 4081 - { 4394 +{ 4395 +"description": "string", ~/~/ Определяет описание 4396 +"subscriberId": "", ~/~/ идентификатор запроса 4397 +"protocolType": 0, ~/~/ Тип протокола 4398 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4399 +"address": "", ~/~/ Адрес события 4400 +"objects": [ ~/~/Объекты для ретрансляции 4401 +{ 4402 +"id": "", ~/~/ идентификатор пользователя 4403 +"name": "string", ~/~/ Название уведомления 4404 +"imei": "string", ~/~/IMEI объекта 4405 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4406 +} 4407 + ], 4408 +"id": "", ~/~/ идентификатор пользователя 4409 +"parentId": "", ~/~/ Guid идентификатор родителя 4410 +"deleted": true ~/~/ Признак удаления 4411 +} 4082 4082 4083 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции 4084 4084 4085 - " driver ": "string", ~/~/ Имя водителя4414 +== **Редактирование ретранслятора** == 4086 4086 4087 - "amount": 0, ~/~/ Количество топлива 4416 +(% class="box infomessage" %) 4417 +((( 4418 +**PUT** **/api/v3/retranslations** 4419 +))) 4088 4088 4089 - "amountDut": 0, ~/~/ КоличествотопливаДУТ4421 +Пример запроса: 4090 4090 4091 - "amountDiff": 0, ~/~/ Разница в литрах 4423 +{ 4424 +"id": "", ~/~/ идентификатор пользователя 4425 +"description": "string", ~/~/ Определяет описание 4426 +"subscriberId": "", ~/~/ идентификатор запроса 4427 +"protocolType": 0, ~/~/ Тип протокола 4428 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4429 +"address": "string", ~/~/ Адрес события 4430 +"objects": ~/~/Объекты для ретрансляции 4431 +[ 4432 +{ 4433 +"id": "", ~/~/ идентификатор пользователя 4434 +"imei": "", ~/~/IMEI объекта 4435 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4436 +} 4437 + ] 4438 +} 4092 4092 4093 - "amountDiffPerc": 0, ~/~/ Разница в % 4094 4094 4095 - "summa": 0, ~/~/ Стоимостьвруб.4441 +Пример ответа: 4096 4096 4097 - "serviceName": "string", ~/~/ Тип топлива 4443 +{ 4444 +"description": "", ~/~/ Определяет описание 4445 +"subscriberId": "", ~/~/ идентификатор запроса 4446 +"protocolType": 0, ~/~/ Тип протокола 4447 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4448 +"address": "string", ~/~/ Адрес события 4449 +"objects": [ ~/~/Объекты для ретрансляции 4450 +{ 4451 +"id": "", ~/~/ идентификатор пользователя 4452 +"name": "string", ~/~/ Название уведомления 4453 +"imei": "", ~/~/IMEI объекта 4454 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4455 +} 4456 + ], 4457 +"id": "", ~/~/ идентификатор пользователя 4458 +"parentId": "", ~/~/ Guid идентификатор родителя 4459 +"deleted": true ~/~/ Признак удаления 4460 +} 4098 4098 4099 - "price": 0, ~/~/ Цена за литр в руб. 4100 4100 4101 - "cardName": "string", ~/~/ НаименованиеТК4463 +== **Получение списка ретранслятора клиента** == 4102 4102 4103 - "cardNum": "string", ~/~/ Номер ТК 4465 +(% class="box infomessage" %) 4466 +((( 4467 +**POST /api/v3/retranslations/find** 4468 +))) 4104 4104 4105 - "operator": "string", ~/~/ ОператорТК4470 +Пример запроса: 4106 4106 4107 - "address": "string", ~/~/ Адрес АЗС 4472 +{ 4473 +"id": "", ~/~/ идентификатор пользователя 4474 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4475 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4476 +} 4108 4108 4109 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guidтопливной карты4478 +Ответ: 4110 4110 4480 +[ 4481 +{ 4482 +"description": "", ~/~/ Определяет описание 4483 +"subscriberId": "", ~/~/ идентификатор запроса 4484 +"protocolType": 0, ~/~/ Тип протокола 4485 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4486 +"address": "string", ~/~/ Адрес события 4487 +"id": "", ~/~/ идентификатор пользователя 4488 +"parentId": "", ~/~/ Guid идентификатор родителя 4489 +"deleted": true ~/~/ Признак удаления 4490 +} 4491 +] 4492 + 4493 + 4494 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4495 + 4496 +== **API для отчета по выгрузке комбайнов** == 4497 + 4498 +(% class="box infomessage" %) 4499 +((( 4500 +POST **/api/v3/Reports/harvesterUnloading** 4501 +))) 4502 + 4503 +Пример запроса: 4504 + 4505 +{ 4506 + "byTime": 0, ~/~/ Объединение событий по времени 4507 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4508 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4509 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4510 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4511 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4512 + 0 4513 + ], 4514 + "from": "", ~/~/ Дата и время начало запроса 4515 + "to": "", ~/~/ Дата и время окончания запроса 4516 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4517 +} 4518 + 4519 +Пример ответа: 4520 + 4521 +[ 4522 + { 4523 + "harvesterName": "", ~/~/Комбайн, номер 4524 + "harvesterId": 0, ~/~/Комбайн, id 4525 +"harvesterModel": "", ~/~/ Модель комбайна 4526 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4527 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4528 + "events": [ ~/~/Список событий в разрезе комбайна 4529 + { 4530 + "driverId": "", ~/~/Идентификатор водителя 4531 + "driverName": "", ~/~/Водитель комбайна, ФИО 4532 + "RFID": "", ~/~/ идентификатор карты-метки 4533 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4534 + "vehicleId": 0, ~/~/идентификатор объекта 4535 + "vehicleName": "string", ~/~/ Имя объекта 4536 + "modelName": "string", ~/~/ Имя модели объекта 4537 + "nearestVehicles": [ ~/~/Объекты рядом 4538 + { 4539 + "vehicleId": 0, ~/~/идентификатор объекта 4540 + "vehicleName": "string" ~/~/ Имя объекта 4541 + } 4542 + ], 4543 + "fields": [ ~/~/Поля, где происходила выгрузка 4544 + { 4545 + "id": 0, ~/~/ идентификатор пользователя 4546 + "name": "string" ~/~/ имя пользователя 4547 + } 4548 + ], 4549 + "event": "string", ~/~/Событие 4550 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4551 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4552 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4553 + "cultureName": "string", ~/~/ название культуры 4554 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4555 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4556 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4557 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4558 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4559 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4560 + "issued": 0, ~/~/Выдано, бункеров 4561 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4562 + "latitude": 0, ~/~/Широта 4563 + "longitude": 0, ~/~/ Долгота 4564 + "litresAway": 0, ~/~/Отдано, л 4565 + "m3Away": 0 ~/~/Отдано, м3 4566 + } 4567 + ] 4111 4111 } 4569 +] 4112 4112 4571 + 4113 4113 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4114 4114 4115 4115 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == ... ... @@ -4128,32 +4128,29 @@ 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 -}, 4590 +[ 4591 + { 4592 + "recordTime": "", ~/~/Время записи 4593 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4594 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4595 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4596 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4597 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4598 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4599 + "items": [ ~/~/ 4600 +nullable: true ~/~/Детали 4601 + { 4602 + "name": "string", ~/~/наименование столбца 4603 + "value": "string" ~/~/содержание столбца 4604 + } 4605 + ] 4606 + }, 4607 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4608 + "string" 4609 + ] 4610 + } 4611 +] 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 4158 4158 (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4159 4159 ... ... @@ -4164,12 +4164,37 @@ 4164 4164 4165 4165 В заголовках запроса: X-Auth: Токен авторизации 4166 4166 4167 -Параметры в теле запроса (JSON): 4623 +Пример запроса: 4624 + 4168 4168 [ 4169 -"eb737fdf-c422-4df7-8727-bd61439b8460", 4170 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4626 +0 4171 4171 ] 4628 + 4172 4172 4630 +Пример ответа: 4631 + 4632 +[ 4633 +{ 4634 + "recordTime": "", ~/~/Время записи 4635 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4636 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4637 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4638 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4639 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4640 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4641 + "items": [ ~/~/Детали 4642 + { 4643 + "name": "", ~/~/Имя свойства 4644 + "value": "" ~/~/Значение свойства 4645 + } 4646 + ] 4647 + }, 4648 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4649 + "" 4650 + ] 4651 + } 4652 +] 4653 + 4173 4173 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4174 4174 4175 4175 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == ... ... @@ -4182,15 +4182,53 @@ 4182 4182 В заголовках запроса: X-Auth: Токен авторизации 4183 4183 4184 4184 Параметры в теле запроса (JSON): 4666 + 4667 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4668 + 4669 +В заголовках запроса: X-Auth: Токен авторизации 4670 + 4671 + 4672 +Пример запроса: 4673 + 4674 +((( 4185 4185 [ 4186 -"eb737fdf-c422-4df7-8727-bd61439b8460", 4187 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4676 +))) 4677 + 4678 +((( 4679 + 0 4680 +))) 4681 + 4682 +((( 4188 4188 ] 4684 +))) 4189 4189 4190 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4191 4191 4687 +Пример ответа: 4192 4192 4689 +[ 4690 +{ 4691 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4692 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4693 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4694 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4695 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4696 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4697 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4698 + "items": [ ~/~/Детали 4699 + { 4700 + "name": "string", ~/~/Имя свойства 4701 + "value": "string" ~/~/Значение свойства 4702 + } 4703 + ] 4704 + }, 4705 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4706 + "string" 4707 + ] 4708 + } 4709 +] 4193 4193 4711 + 4712 + 4194 4194 (% class="box" lang="en-US" style="text-align: center;" %) 4195 4195 ((( 4196 4196 (% 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]] **