Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - 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" %) ... ... @@ -173,7 +173,6 @@ 173 173 { 174 174 "agentId": "",(% style="color:#000000" %) (%%) 175 175 "parentId": "", 176 - "parentName": "string", 177 177 "name": "string", 178 178 "fullName": "string", 179 179 "agentInfoType": 0, ... ... @@ -184,7 +184,6 @@ 184 184 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 185 185 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 186 186 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 188 188 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 189 189 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 190 190 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) ... ... @@ -228,7 +228,6 @@ 228 228 "bankKS": "string" ~/~/ корр. счёт 229 229 } 230 230 231 - 232 232 Ответ: 233 233 234 234 { ... ... @@ -422,7 +422,6 @@ 422 422 ], 423 423 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 424 424 } 425 - 426 426 { 427 427 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 428 428 "lastName": "string", ... ... @@ -436,12 +436,8 @@ 436 436 437 437 (% style="text-align:left" %) 438 438 (% style="color:#000000; font-weight:normal" %)Ответ: 439 - 440 -(% style="text-align:left" %) 441 -(% style="color:#000000; font-weight:normal" %){ 442 - 443 -(% style="text-align:left" %) 444 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 443 +{ 444 + "id": "" , ~/~/ ID пользователя 445 445 "lastName": "" , ~/~/ Фамилия , 446 446 "firstName": "" , ~/~/ Имя 447 447 "position": "" , ~/~/ Должность ... ... @@ -458,11 +458,9 @@ 458 458 "kind": "" , ~/~/ тип аутентификации 459 459 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 460 460 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 461 +} 461 461 462 -(% style="text-align:left" %) 463 -(% style="color:#000000; font-weight:normal" %)} 464 464 465 - 466 466 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 467 467 468 468 (% class="box infomessage" %) ... ... @@ -482,19 +482,16 @@ 482 482 483 483 (% style="color:#000000" %)Параметры в теле запроса (JSON): 484 484 485 -(% style="color:#000000" %){ 486 - 483 +(% style="color:#000000" %){(%%) 487 487 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 488 488 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 489 489 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 490 490 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 491 - 492 492 (% style="color:#000000" %)} 493 493 494 494 (% style="color:#000000" %)Ответ: 495 495 496 496 (% style="color:#000000" %){ (%%) 497 - 498 498 "id": "" , ~/~/ идентификатор пользователя 499 499 "lastName": "" , ~/~/ фамилия 500 500 "firstName": "" , ~/~/ имя ... ... @@ -508,7 +508,6 @@ 508 508 "sessionDuration":"", ~/~/ длительность сессии в минутах 509 509 "status": "1", ~/~/ статус пользователя 510 510 "lastLogged": "", ~/~/ дата/время последней авторизации 511 - 512 512 (% style="color:#000000" %)} 513 513 514 514 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -582,10 +582,8 @@ 582 582 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 583 583 584 584 (% lang="en-US" style="text-align:left" %) 585 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 586 - 587 -(% lang="en-US" style="text-align:left" %) 588 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 580 + "id": "" , ~/~/ ID пользователя 589 589 "lastName": "" , ~/~/ фамилия 590 590 "firstName": "" , ~/~/ имя 591 591 "position": "" , ~/~/ должность ... ... @@ -607,9 +607,7 @@ 607 607 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 608 608 }, 609 609 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 610 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 611 - 612 -(% lang="en-US" style="text-align:left" %) 602 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 613 613 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 614 614 615 615 (% lang="en-US" style="text-align:left" %) ... ... @@ -616,10 +616,8 @@ 616 616 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 617 617 618 618 (% lang="en-US" style="text-align:left" %) 619 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 620 - 621 -(% lang="en-US" style="text-align:left" %) 622 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 610 + "id": "" , ~/~/ идентификатор пользователя 623 623 "lastName": "" , ~/~/ фамилия 624 624 "firstName": "" , ~/~/ имя 625 625 "position": "" , ~/~/ должность ... ... @@ -640,10 +640,8 @@ 640 640 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 641 641 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 642 642 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 631 +} 643 643 644 -(% lang="en-US" style="text-align:left" %) 645 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 646 - 647 647 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 648 648 649 649 (% class="box warningmessage" %) ... ... @@ -663,12 +663,10 @@ 663 663 664 664 (% style="color:#000000" %)Параметры в теле запроса (JSON): 665 665 666 -(% style="color:#000000" %){ 667 - 652 +(% style="color:#000000" %){(%%) 668 668 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 669 669 "description": "" , ~/~/ описание 670 670 "data": "" , ~/~/ данные, связанные со сменой статуса 671 - 672 672 (% style="color:#000000" %)} 673 673 674 674 (% style="text-align:left" %) ... ... @@ -690,7 +690,7 @@ 690 690 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 691 691 692 692 [ 693 - 677 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 694 694 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 695 695 ] 696 696 ... ... @@ -996,7 +996,7 @@ 996 996 997 997 Ответ: В случае успеха **Success 200** 998 998 999 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 1000 1000 1001 1001 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 1002 1002 ... ... @@ -1032,19 +1032,15 @@ 1032 1032 "deviceTypeName": "", ~/~/ Название типа устройства 1033 1033 "sim1": "", ~/~/ Номер SIM1 1034 1034 "sim2": "", ~/~/ Номер SIM2 1035 - 1036 1036 "parentId": "", ~/~/ ID клиента-родителя 1037 1037 "parentName": "", ~/~/ Наименование клиента-родителя 1038 1038 "modelId": "", ~/~/ ID модели объекта 1039 1039 "modelName": "", ~/~/ Имя модели объекта 1040 - 1041 1041 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1042 1042 "unitName": "string", ~/~/ Наименование подразделения 1043 1043 "status": 0, ~/~/ Статус объекта 1044 - 1045 1045 "createdAt": "", ~/~/ Дата создания объекта 1046 1046 }, 1047 - 1048 1048 "customFields": [ ~/~/ Произвольные поля 1049 1049 { 1050 1050 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1067,8 +1067,7 @@ 1067 1067 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1068 1068 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1069 1069 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1070 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1071 - 1050 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1072 1072 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1073 1073 "mileageCoeff": 0, ~/~/ коэффициент пробега 1074 1074 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1098,7 +1098,6 @@ 1098 1098 "retries": 0 ~/~/ Количество попыток 1099 1099 } 1100 1100 ], 1101 - 1102 1102 "sensors": [ ~/~/ Датчики 1103 1103 { 1104 1104 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1139,31 +1139,19 @@ 1139 1139 }, 1140 1140 1141 1141 ~/~/ Характерные для произвольного: 1142 - 1143 1143 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1144 - 1145 1145 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1146 - 1147 1147 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1148 - 1149 1149 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1150 - 1151 1151 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1152 - 1153 1153 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1154 - 1155 1155 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1156 - 1157 1157 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1158 - 1159 1159 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1160 - 1161 1161 ~/~/ "ValueOn": "Вкл.", 1162 - 1163 1163 ~/~/ "ValueOff": "Выкл." 1164 1164 "summaryMaxValue": 0 ~/~/ Макс. значение 1165 1165 } 1166 - 1167 1167 "drivers": [ ~/~/ Водители 1168 1168 { 1169 1169 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1172,7 +1172,6 @@ 1172 1172 "isDefault": true ~/~/ По умолчанию 1173 1173 } 1174 1174 ], 1175 - 1176 1176 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1177 1177 { 1178 1178 "id": "", ~/~/ ID задания ... ... @@ -1189,8 +1189,7 @@ 1189 1189 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1190 1190 } 1191 1191 ], 1192 - 1193 - "statusHistory": [ ~/~/ История статусов 1157 +"statusHistory": [ ~/~/ История статусов 1194 1194 { 1195 1195 "status": 0, 1196 1196 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1198,7 +1198,6 @@ 1198 1198 "additionalInfo": "string" 1199 1199 } 1200 1200 ] 1201 - 1202 1202 } 1203 1203 ))) 1204 1204 ... ... @@ -1208,6 +1208,73 @@ 1208 1208 (% style="text-align:left" %) 1209 1209 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1210 1210 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 + 1211 1211 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1212 1212 1213 1213 (% class="box successmessage" %) ... ... @@ -1225,8 +1225,7 @@ 1225 1225 1226 1226 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1227 1227 1228 -(% style="color:#000000" %){ 1229 - 1258 +(% style="color:#000000" %){(%%) 1230 1230 "parentId": "" , ~/~/ ID клиента 1231 1231 "name": "" , ~/~/ имя ТС 1232 1232 "imei": "" , ~/~/ IMEI ... ... @@ -1247,7 +1247,6 @@ 1247 1247 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1248 1248 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1249 1249 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1250 - 1251 1251 "mileageCalcMethod": 0, 1252 1252 "mileageCoeff": 0, 1253 1253 "locationByCellId": true, ... ... @@ -1280,7 +1280,6 @@ 1280 1280 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1281 1281 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1282 1282 } 1283 - 1284 1284 "drivers": [ ~/~/ Водители 1285 1285 { 1286 1286 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1295,8 +1295,7 @@ 1295 1295 "retries": 0 1296 1296 } 1297 1297 ], 1298 - 1299 - "sensors": [ ~/~/ Датчики 1325 +"sensors": [ ~/~/ Датчики 1300 1300 { 1301 1301 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1302 1302 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1334,41 +1334,43 @@ 1334 1334 "additionalProp2": "string", 1335 1335 "additionalProp3": "string" 1336 1336 }, 1337 - 1338 1338 ~/~/ Характерные для произвольного: 1339 - 1340 1340 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1341 - 1342 1342 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1343 - 1344 1344 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1345 - 1346 1346 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1347 - 1348 1348 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1349 - 1350 1350 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1351 - 1352 1352 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1353 - 1354 1354 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1355 - 1356 1356 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1357 - 1358 1358 ~/~/ "ValueOn": "Вкл.", 1359 - 1360 1360 ~/~/ "ValueOff": "Выкл." 1361 - "summaryMaxValue": 0 ~/~/ Макс. значение 1375 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1376 + 1377 +((( 1378 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1379 + { 1380 + "from": 0, ~/~/ С какого значения 1381 + "color": "string", ~/~/ Каким цветом 1382 + "text": "string" ~/~/ Текст подписи к этому интервалу 1383 + } 1384 + ] 1362 1362 } 1363 1363 ], 1387 +))) 1388 + 1389 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1390 + 1391 + 1364 1364 "customFields": [ ~/~/ Произвольные поля 1365 1365 { 1366 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1367 - "name": "string", 1368 - "value": "string", 1369 - "forClient": true, 1370 - "forTooltip": true, 1371 - "forReport": true 1394 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1395 + "name": "string", ~/~/ Наименование произвольного поля 1396 + "value": "string", ~/~/ Значение произвольного поля 1397 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1398 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1399 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1372 1372 } 1373 1373 ] 1374 1374 } ... ... @@ -1375,62 +1375,240 @@ 1375 1375 1376 1376 (% style="color:#000000" %)Ответ: 1377 1377 1378 -(% style="color:#000000" %){ 1379 1379 1380 - "vehicleId": "", ~/~/ID ТС 1381 - "parentId": "", ~/~/Guid владельца ТС 1382 - "name": "", ~/~/Имя объекта 1383 - "imei": "", ~/~/IMEI 1384 - "deviceTypeId": "", ~/~/ID типа устройства 1385 - "modelId": "", ~/~/ID модели 1386 - "unitId": "", ~/~/ID подразделения 1387 - "sim1": "", ~/~/SIM1 1388 - "sim2": "", ~/~/SIM2 1389 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1390 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1391 - "counters": { ~/~/Счётчики 1392 - "mileageEnabled": true, 1393 - "motohoursEnabled": true, 1394 - "mileage": "", 1395 - "motohours": 345.0 1396 - }, 1397 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1398 - "id": null, 1399 - "enabled": true, ~/~/флаг включения 1400 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1401 - "login": "", ~/~/ имя учетной записи 1402 - "password": "" ~/~/ пароль учетной записи 1403 - }, 1404 - "inspectionTasks": { ~/~/ задания на ТО 1405 - "id": "", ~/~/ ID задачи 1406 - "enabled": false, ~/~/ Признак включения 1407 - "name": "", ~/~/ Имя задания 1408 - "description": "", ~/~/ Описание задания 1409 - "mileageCondition": "", ~/~/ Условие по пробегу 1410 - "lastMileage": "", ~/~/ Пробег (в метрах) 1411 - "motohoursCondition": "", ~/~/ Условие по моточасам 1412 - "lastMotohours": "", ~/~/ Моточасы 1413 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1414 - "kind": "", ~/~/ Вид периодичности по времени 1415 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1407 +((( 1408 +((( 1409 +((( 1410 +{ 1411 + "vehicleId": 0, ~/~/ ID ТС 1412 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1413 + "name": "string", ~/~/ Имя объекта 1414 + "imei": "string", ~/~/ IMEI 1415 + "deviceTypeId": 0, ~/~/ ID типа устройства 1416 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1417 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1418 + "sim1": "string", ~/~/ SIM1 1419 + "sim2": "string", ~/~/ SIM2 1420 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1421 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1422 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1423 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1424 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1425 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1426 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1427 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1428 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1429 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1430 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1431 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1432 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1433 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1434 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1435 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1436 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1437 + "counters": { ~/~/ Dto для состояний счётчиков 1438 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1439 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1440 + "mileage": 0, ~/~/ Пробег 1441 + "motohours": 0 ~/~/ Моточасы 1442 + }, 1443 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1444 + "id": "string", ~/~/ CMSV6 Идентификатор 1445 + "enabled": true, ~/~/ Признак включения 1446 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1447 + "login": "string", ~/~/ CMSV6 имя учетной записи 1448 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1449 + }, 1450 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1451 + { 1452 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1453 + "enabled": true, ~/~/ Признак включения 1454 + "name": "string", ~/~/ Имя задания 1455 + "description": "string", ~/~/ Описание задания 1456 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1457 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1458 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1459 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1460 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1461 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1462 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1463 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1416 1416 } 1465 + ], 1466 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1467 + { 1468 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1469 + "inputNumber": 0, ~/~/ № входа. 1470 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1471 + "comment": "string", ~/~/ Комментарий 1472 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1473 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1474 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1475 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1476 + } 1477 + ], 1478 + "commandTemplates": [ ~/~/ Список шаблонов команд 1479 + { 1480 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1481 + "name": "string", ~/~/ Название шаблона команд 1482 + "command": "string", ~/~/ Команда на выполнение 1483 + "retries": 0 ~/~/ Лимит попыток отправки 1484 + } 1485 + ], 1486 + "sensors": [ ~/~/ Список датчиков 1487 + { 1488 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1489 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1490 + "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 1491 + "name": "string", ~/~/ Имя датчика 1492 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1493 + "inputNumber": 0, ~/~/ Номер входа 1494 + "pseudonym": "string", ~/~/ Псевдоним 1495 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1496 + "isInverted": true, ~/~/ Признак инверсии 1497 + "disabled": true, ~/~/ Датчик не участвует в обработке 1498 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1499 + "gradesTables": [ ~/~/ Тарировка 1500 + { 1501 + "grades": [ ~/~/ Таблицы тарировки 1502 + { 1503 + "input": 0, ~/~/ Вход 1504 + "output": 0 ~/~/ Выход 1505 + } 1506 + ], 1507 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1508 + } 1509 + ], 1510 + "showInTooltip": true, ~/~/ Отображение в подсказке 1511 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1512 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1513 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1514 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1515 + "expr": "string", ~/~/ Выражение 1516 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1517 + "string" 1518 + ], 1519 + "customParams": { 1520 + "additionalProp1": "string", 1521 + "additionalProp2": "string", 1522 + "additionalProp3": "string" 1523 + }, 1524 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1525 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1526 + { 1527 + "from": 0, ~/~/ С какого значения 1528 + "color": "string", ~/~/ Каким цветом 1529 +))) 1417 1417 1418 -(% style="text-align:left" %) 1419 -(% style="color:#000000" %)} 1531 +((( 1532 + "text": "string" ~/~/ Текст подписи к этому интервалу 1533 + } 1534 + ] 1535 + } 1536 + ], 1537 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1538 + "customFields": [ ~/~/ Список произвольных полей 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1541 + "name": "string", ~/~/ Наименование произвольного поля 1542 + "value": "string", ~/~/ Значение произвольного поля 1543 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1544 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1545 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1546 + } 1547 + ], 1548 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1549 +} 1550 +))) 1551 +))) 1552 +))) 1420 1420 1554 + 1421 1421 **Валидация:** 1422 1422 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1423 1423 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1424 1424 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1425 1425 1426 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1427 1427 1561 +== **Импортировать историю ТС (Асинхронный запрос)** == 1562 + 1563 +(% class="box successmessage" %) 1564 +((( 1565 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1566 +))) 1567 + 1568 +Метод запроса: **POST** 1569 + 1570 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1571 + 1572 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1573 + 1574 + 1575 +Ответ: 1576 + 1577 +{ 1578 + 1579 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1580 + 1581 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1582 + 1583 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1584 + 1585 + "Message": "string", ~/~/ Информация о выполнении запроса 1586 + 1587 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1588 + 1589 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1590 + 1591 + "Data": "string" ~/~/ Данные 1592 + 1593 +} 1594 + 1595 + 1596 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1597 + 1428 1428 (% class="box infomessage" %) 1429 1429 ((( 1600 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1601 +))) 1602 + 1603 +Метод запроса: **GET** 1604 + 1605 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1606 + 1607 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1608 + 1609 + 1610 +Ответ: 1611 + 1612 +{ 1613 + 1614 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1615 + 1616 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1617 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1618 + 1619 + "Message": "string", ~/~/ Информация о выполнении запроса 1620 + 1621 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1622 + 1623 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1624 + 1625 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1626 + 1627 + "Data": "string" ~/~/ Данные 1628 + 1629 +} 1630 + 1631 + 1632 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1633 + 1634 +(% class="box infomessage" %) 1635 +((( 1430 1430 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1431 1431 ))) 1432 1432 1433 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1639 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1434 1434 1435 1435 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1436 1436 ... ... @@ -1464,9 +1464,12 @@ 1464 1464 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1465 1465 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1466 1466 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1467 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1468 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1469 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1673 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1674 + "unitName": "string", ~/~/ Название подразделения (опционально) 1675 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1676 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1677 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1678 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1470 1470 } 1471 1471 1472 1472 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1473,8 +1473,14 @@ 1473 1473 1474 1474 (% style="color:#000000" %)Ответ: 1475 1475 1476 -(% style="color:#000000" %){ 1685 +(% style="color:#000000" %)[ 1686 +{ 1477 1477 1688 +((( 1689 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1690 +))) 1691 + 1692 +((( 1478 1478 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1479 1479 "name": "" ~/~/ наименование объекта 1480 1480 "imei": "" ~/~/ IMEI объекта ... ... @@ -1500,9 +1500,21 @@ 1500 1500 "forClient": true, ~/~/ право на отображение у клиента 1501 1501 "forTooltip": false, ~/~/ право на отображение в подсказке 1502 1502 "forReport": false ~/~/ право на отображение в отчетах 1503 - }(%%) 1504 -(% style="color:#000000" %)} 1718 +))) 1505 1505 1720 +((( 1721 + } 1722 + ], 1723 + "vehicleGroups": [ ~/~/ Группы ТС 1724 + { 1725 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1726 + "name": "string" ~/~/ Наименование группы ТС 1727 + } 1728 + ] 1729 + } 1730 +] 1731 +))) 1732 + 1506 1506 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1507 1507 1508 1508 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1534,13 +1534,11 @@ 1534 1534 "data": "", ~/~/ Данные 1535 1535 "overwrite": false, ~/~/ Флаг перезаписи 1536 1536 "stage": "", ~/~/ Состояние, может быть null 1537 - 1538 1538 (% style="color:#000000" %)} 1539 1539 1540 1540 (% style="color:#000000" %)Ответ: 1541 1541 1542 -(% style="color:#000000" %){ 1543 - 1768 +(% style="color:#000000" %){(%%) 1544 1544 "status": "", ~/~/ значение статуса 1545 1545 "date": "", ~/~/ Дата смены статуса 1546 1546 "description": "", ~/~/ Описание ... ... @@ -1547,10 +1547,10 @@ 1547 1547 "data": "", ~/~/ Данные 1548 1548 "overwrite": false, ~/~/ Флаг перезаписи 1549 1549 "stage": "", ~/~/ Состояние 1550 - 1551 -(% style="text-align:left" %) 1552 1552 (% style="color:#000000" %) } 1553 1553 1777 +== == 1778 + 1554 1554 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1555 1555 1556 1556 (% class="box warningmessage" %) ... ... @@ -1638,8 +1638,7 @@ 1638 1638 "retries": 0 1639 1639 } 1640 1640 ], 1641 - 1642 - "sensors": [ ~/~/ Датчики 1866 +"sensors": [ ~/~/ Датчики 1643 1643 { 1644 1644 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1645 1645 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1677,95 +1677,215 @@ 1677 1677 "additionalProp2": "string", 1678 1678 "additionalProp3": "string" 1679 1679 }, 1680 - 1681 1681 ~/~/ Характерные для произвольного: 1682 - 1683 1683 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1684 - 1685 1685 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1686 - 1687 1687 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1688 - 1689 1689 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1690 - 1691 1691 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1692 - 1693 1693 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1694 - 1695 1695 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1696 - 1697 1697 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1698 - 1699 1699 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1700 - 1701 1701 ~/~/ "ValueOn": "Вкл.", 1702 - 1703 1703 ~/~/ "ValueOff": "Выкл." 1704 1704 "summaryMaxValue": 0 ~/~/ Макс. значение 1917 + 1918 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1919 + { 1920 + "from": 0, ~/~/ С какого значения 1921 + "color": "string", ~/~/ Каким цветом 1922 + "text": "string" ~/~/ Текст подписи к этому интервалу 1923 + } 1924 + ] 1705 1705 } 1706 1706 ], 1927 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1928 + 1707 1707 "customFields": [ ~/~/ Произвольные поля 1708 - { 1709 - 1710 - "name": "string", 1711 - "value": "string", 1712 - "forClient": true, 1713 - "forTooltip": true, 1714 - "forReport": true 1930 + { 1931 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1932 + "name": "string", ~/~/ Наименование произвольного поля 1933 + "value": "string", ~/~/ Значение произвольного поля 1934 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1935 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1936 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1715 1715 } 1716 1716 ] 1717 1717 } 1718 1718 1941 + 1719 1719 (% style="color:#000000" %)Ответ: 1720 1720 1721 -(% lang="en-US" style="text-align:left" %) 1722 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1944 +((( 1945 +{ 1946 + "vehicleId": 0, ~/~/ ID ТС 1947 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1948 + "name": "string", ~/~/ Имя объекта 1949 + "imei": "string", ~/~/ IMEI 1950 + "deviceTypeId": 0, ~/~/ ID типа устройства 1951 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1952 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1953 + "sim1": "string", ~/~/ SIM1 1954 + "sim2": "string", ~/~/ SIM2 1955 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1956 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1957 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1958 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1959 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1960 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1961 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1962 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1963 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1964 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1965 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1966 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1967 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1968 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1969 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1970 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1971 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1972 + "counters": { ~/~/ состояний счётчиков 1973 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1974 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1975 + "mileage": 0, ~/~/ Пробег 1976 + "motohours": 0 ~/~/ Моточасы 1977 + }, 1978 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1979 + "id": "string", ~/~/ CMSV6 Идентификатор 1980 + "enabled": true, ~/~/ Признак включения 1981 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1982 +))) 1723 1723 1724 -(% lang="en-US" style="text-align:left" %) 1725 - "vehicleId": "", ~/~/ ID ТС 1726 - "parentId": "", ~/~/ ID клиента 1727 - "name": "", ~/~/ имя ТС 1728 - "imei": "", ~/~/ IMEI 1729 - "deviceTypeId": "", ~/~/ типа устройства 1730 - "modelId": "", ~/~/ ID модели 1731 - "unitId": "", ~/~/ ID подразделения 1732 - "sim1": "", ~/~/ SIM 1 1733 - "sim2": "", ~/~/ SIM2 1734 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1735 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1736 - "counters": 1737 - { 1738 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1739 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1740 - "mileage": "", ~/~/ пробег 1741 - "motohours": "", ~/~/ моточасы 1742 - } 1743 - "cmsv6Parameters": ~/~/ параметры CMSv6 1984 + 1985 +((( 1986 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1987 + "login": "string", ~/~/ CMSV6 имя учетной записи 1988 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1989 + }, 1990 + "inspectionTasks": [ ~/~/ Задания на ТО 1991 + { 1992 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1993 + "enabled": true, ~/~/ Признак включения 1994 + "name": "string", ~/~/ Имя задания 1995 + "description": "string", ~/~/ Описание задания 1996 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1997 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1998 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1999 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2000 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2001 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2002 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2003 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2004 + } 2005 + ], 2006 + "drivers": [ ~/~/ Список водителей 2007 + { 2008 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2009 + "inputNumber": 0, ~/~/ № входа. 2010 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2011 + "comment": "string", ~/~/ Комментарий. 2012 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2013 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2014 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2015 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2016 + } 2017 + ], 2018 + "commandTemplates": [ ~/~/ Список шаблонов команд 2019 + { 2020 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2021 + "name": "string", ~/~/ Название шаблона команд 2022 + "command": "string", ~/~/ Команда на выполнение 2023 + "retries": 0 ~/~/ Лимит попыток отправки 2024 + } 2025 + ], 2026 + "sensors": [ ~/~/ Список датчиков 2027 + { 2028 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2029 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2030 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2031 +))) 2032 + 2033 +((( 2034 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2035 +))) 2036 + 2037 +((( 2038 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2039 +))) 2040 + 2041 +((( 2042 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2043 +))) 2044 + 2045 +((( 2046 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2047 +))) 2048 + 2049 +((( 2050 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2051 + "name": "string", ~/~/ Имя датчика 2052 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2053 +))) 2054 + 2055 +((( 2056 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2057 + "inputNumber": 0, ~/~/ Номер входа 2058 + "pseudonym": "string", ~/~/ Псевдоним 2059 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2060 + "isInverted": true, ~/~/ Признак инверсии 2061 + "disabled": true, ~/~/ Датчик не участвует в обработке 2062 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2063 + "gradesTables": [ ~/~/ Тарировка 1744 1744 { 1745 - "id": ~/~/ идентификатор 1746 - "enabled": true, ~/~/ флаг включения 1747 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1748 - "login": "", ~/~/ имя учетной записи 1749 - "password": "", ~/~/ пароль учетной записи 1750 - } 1751 - "inspectionTasks": ~/~/ задания на ТО 2065 + "grades": [ ~/~/ Таблицы тарировки 2066 + { 2067 + "input": 0, ~/~/ Вход 2068 + "output": 0 ~/~/ Выход 2069 + } 2070 + ], 2071 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2072 + } 2073 + ], 2074 + "showInTooltip": true, ~/~/ Отображение в подсказке 2075 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2076 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2077 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2078 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2079 + "expr": "string", ~/~/ Выражение 2080 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2081 + "string" 2082 + ], 2083 + "customParams": { ~/~/ Дополнительные настройки 2084 + "additionalProp1": "string", 2085 + "additionalProp2": "string", 2086 + "additionalProp3": "string" 2087 + }, 2088 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2089 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1752 1752 { 1753 - "id": "", ~/~/ ID задания 1754 - "enabled": false, ~/~/ Признак включения 1755 - "name": "", ~/~/ Имя задания 1756 - "description": "", ~/~/ Описание задания 1757 - "mileageCondition": "", ~/~/ Условие по пробегу 1758 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1759 - "motohoursCondition": "", ~/~/ Условие по моточасам 1760 - "lastMotohours": "", ~/~/ Моточасы 1761 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1762 - "kind": "", ~/~/ Вид периодичности по времени 1763 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2091 + "from": 0, ~/~/ С какого значения 2092 + "color": "string", ~/~/ Каким цветом 2093 + "text": "string" ~/~/ Текст подписи к этому интервалу 1764 1764 } 2095 + ] 2096 + } 2097 + ], 2098 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2099 + "customFields": [ ~/~/ Список произвольных полей 2100 + { 2101 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2102 + "name": "string", ~/~/ Наименование произвольного поля 2103 + "value": "string", ~/~/ Значение произвольного поля 2104 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2105 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2106 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2107 + } 2108 + ], 2109 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2110 +} 2111 +))) 1765 1765 1766 -(% lang="en-US" style="text-align:left" %) 1767 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1768 - 1769 1769 **Валидация:** 1770 1770 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1771 1771 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1804,18 +1804,15 @@ 1804 1804 1805 1805 (% style="color:#000000" %)Метод запроса: **GET** 1806 1806 1807 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2151 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1808 1808 1809 1809 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1810 1810 1811 1811 (% style="color:#000000" %)Ответ: 1812 1812 1813 -(% style="color:#000000" %){ 1814 - 2157 +(% style="color:#000000" %){(%%) 1815 1815 "deviceTypeId" : "", ~/~/ ID типа устройства 1816 1816 "deviceTypeName" : "" ~/~/ Название типа устройства 1817 - 1818 -(% style="text-align:left" %) 1819 1819 (% style="color:#000000" %)} 1820 1820 1821 1821 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1837,13 +1837,10 @@ 1837 1837 1838 1838 (% style="color:#000000" %)Ответ: 1839 1839 1840 -(% style="color:#000000" %){ 1841 - 2181 +(% style="color:#000000" %){(%%) 1842 1842 "id": "", ~/~/ ID типа датчика 1843 1843 "name": "", ~/~/ Название 1844 1844 "description": "", ~/~/ Описание 1845 - 1846 -(% style="text-align:left" %) 1847 1847 (% style="color:#000000" %)} 1848 1848 1849 1849 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1930,8 +1930,13 @@ 1930 1930 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1931 1931 |protocolType|Тип протокола 1932 1932 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1933 -|inputNumber|Номер входа 2271 +|inputNumber|((( 2272 +Номер входа 2273 +))) 1934 1934 2275 +(% class="wikigeneratedid" %) 2276 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]] 2277 + 1935 1935 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1936 1936 1937 1937 (% class="box infomessage" %) ... ... @@ -1956,6 +1956,11 @@ 1956 1956 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1957 1957 } 1958 1958 2302 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2303 +|vehicleId|ID объекта 2304 +|from|Дата и время начала периода запроса 2305 +|to|Дата и время окончания периода запроса 2306 + 1959 1959 Ответ: 1960 1960 1961 1961 [ ... ... @@ -1962,25 +1962,43 @@ 1962 1962 { 1963 1963 "messages": [ 1964 1964 { 1965 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1966 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1967 - "speed": 0, ~/~/ Скорость, км/ч 1968 - "altitude": 0, ~/~/ Высота, м 1969 - "latitude": 0, ~/~/ Широта [-90°;90°] 1970 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1971 - "satellites": 0, ~/~/ Кол-во спутников 1972 - "voltage": 0, ~/~/ Напряжение 1973 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2313 + "deviceTime": "2023-11-29T07:40:44.052Z", 2314 + "serverTime": "2023-11-29T07:40:44.052Z", 2315 + "speed": 0, 2316 + "altitude": 0, 2317 + "latitude": 0, 2318 + "longitude": 0, 2319 + "satellites": 0, 2320 + "course": 0, 2321 + "voltage": 0, 2322 + "parameters": { 1974 1974 "additionalProp1": "string", 1975 1975 "additionalProp2": "string", 1976 1976 "additionalProp3": "string" 1977 1977 }, 1978 - "photoCount": 0 ~/~/ Кол-во фото 2327 + "photoCount": 0, 2328 + "lbsCorrectedCoords": true, 2329 + "protocolType": 0 1979 1979 } 1980 1980 ] 1981 1981 } 1982 1982 ] 1983 1983 2335 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2336 +|deviceTime|Время сообщения терминала 2337 +|serverTime|Время когда сообщение поступило на сервер 2338 +|speed|Скорость 2339 +|altitude|Высота над уровнем моря 2340 +|latitude|Широта 2341 +|longitude|Долгота 2342 +|satellites|Кол-во спутников 2343 +|course|Курс 2344 +|voltage|Бортовое напряжение 2345 +|parameters|Список параметров и их значений 2346 +|photoCount|Количество фото 2347 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2348 +|protocolType|ID типа протокола 2349 + 1984 1984 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1985 1985 1986 1986 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2017,10 +2017,12 @@ 2017 2017 { 2018 2018 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2019 2019 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2020 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2021 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2022 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2023 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2386 + "mileage": 0, ~/~/ Пробег за период, километры 2387 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2388 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2389 + "motohours": 0, ~/~/ Моточасы за период, секунды 2390 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2391 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2024 2024 } 2025 2025 ] 2026 2026 } ... ... @@ -2069,6 +2069,12 @@ 2069 2069 } 2070 2070 ] 2071 2071 2440 +(% class="box warningmessage" %) 2441 +((( 2442 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2443 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2444 +))) 2445 + 2072 2072 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2073 2073 2074 2074 (% class="box infomessage" %) ... ... @@ -2114,6 +2114,96 @@ 2114 2114 } 2115 2115 ] 2116 2116 2491 + 2492 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2493 + 2494 +(% class="box infomessage" %) 2495 +((( 2496 +**POST /api/v3/vehicles/moveStop** 2497 +))) 2498 + 2499 +Метод запроса: **POST** 2500 + 2501 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2502 + 2503 +В заголовках запроса: X-Auth: Токен авторизации 2504 + 2505 + 2506 +Тело запроса: 2507 + 2508 +{ 2509 + "vehicleIds": [ ], ~/~/ Список ID объектов 2510 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2511 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2512 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2513 +} 2514 + 2515 +Ответ: 2516 + 2517 +[ 2518 + { 2519 + "vehicleId": 0, ~/~/ ID объекта 2520 + "vehicleName": "string", ~/~/ Имя объекта 2521 + "moves": [ ~/~/ Событие движения 2522 + { 2523 + "mileage": 0, ~/~/ Пробег, км 2524 + "eventId": 0, ~/~/ Идентификатор события 2525 + "eventName": "string", ~/~/ Название события 2526 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2527 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2528 + "duration": 0 ~/~/ Продолжительность события, секунд 2529 + } 2530 + ], 2531 + "stops": [ ~/~/ События стоянок 2532 + { 2533 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2534 + "eventId": 0, ~/~/ Идентификатор события 2535 + "eventName": "string", ~/~/ Название события 2536 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2537 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2538 + "duration": 0 ~/~/ Продолжительность события, секунд 2539 + } 2540 + ] 2541 + } 2542 +] 2543 + 2544 + 2545 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2546 + 2547 +(% class="box infomessage" %) 2548 +((( 2549 +**POST /api/v3/vehicles/getlastdata** 2550 +))) 2551 + 2552 +Метод запроса: **POST** 2553 + 2554 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2555 + 2556 +В заголовках запроса: X-Auth: Токен авторизации 2557 + 2558 + 2559 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2560 + 2561 +Ответ: 2562 + { 2563 + "vehicleId": 0, ~/~/Идентификатор объекта. 2564 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2565 + "vehicleNumber": "string",~/~/Номер объекта. 2566 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2567 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2568 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2569 + "speed": 0,~/~/Скорость объекта. 2570 + "course": 0,~/~/Курс движения [0;360] 2571 + "latitude": 0,~/~/Широта [-90°;90°]. 2572 + "longitude": 0,~/~/Долгота [-180°;180°]. 2573 + "address": "string",~/~/Адрес. 2574 + "geozones": [ ~/~/Сведения по геозонам. 2575 + { 2576 + "id": 0, 2577 + "name": "string" 2578 + } 2579 + 2580 + 2117 2117 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2118 2118 2119 2119 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2421,6 +2421,32 @@ 2421 2421 2422 2422 Success 2423 2423 2888 + 2889 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2890 + 2891 +(% class="box warningmessage" %) 2892 +((( 2893 +**PUT** /api/v3/notifications/prolongation 2894 +))) 2895 + 2896 +Метод позволяет продлить уведомления. 2897 + 2898 +Метод запроса **PUT** 2899 + 2900 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2901 + 2902 +В заголовках запроса: X-Auth: Токен авторизации. 2903 + 2904 +Тело запроса: 2905 + 2906 +[ 2907 + 2908 +0 2909 + 2910 +] 2911 + 2912 +где 0 идентификатор ids. 2913 + 2424 2424 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2425 2425 2426 2426 (% class="box errormessage" %) ... ... @@ -3611,7 +3611,7 @@ 3611 3611 **POST /api/v3/vehicles/import/{agentId}** 3612 3612 ))) 3613 3613 3614 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 4104 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3615 3615 3616 3616 В пути указывается **agentId** - id клиента. 3617 3617 ... ... @@ -3623,7 +3623,7 @@ 3623 3623 3624 3624 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3625 3625 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3626 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1- Замена,2- Слияние,3- Добавление4116 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3627 3627 3628 3628 В теле использовать тип **form-data,** тип значения** file** 3629 3629 ... ... @@ -3790,7 +3790,7 @@ 3790 3790 3791 3791 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3792 3792 3793 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==4283 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3794 3794 3795 3795 (% class="box infomessage" %) 3796 3796 ((( ... ... @@ -3802,64 +3802,67 @@ 3802 3802 Тело запроса: 3803 3803 3804 3804 { 3805 - "vehicleIds": [vehicleId], 3806 - "from": "2023-11-22T09:29:48.051Z", 3807 - "to": "2023-11-22T09:29:48.051Z" 4295 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4296 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4297 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 3808 3808 } 3809 3809 3810 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3811 -|vehicleIds|Массив ID объектов 3812 -|from|Дата начала запроса 3813 -|to|Дата окончания запроса 3814 - 3815 3815 Ответ: 3816 3816 3817 3817 { 3818 - "items": [ 4303 + "items": [ ~/~/ Список в разрезе ТС 3819 3819 { 3820 - "from": "2023-11-22T09:29:48.052Z", 3821 - "to": "2023-11-22T09:29:48.052Z", 3822 - "vehicleId": 0, 3823 - "vehicleName": "string", 3824 - "vehicleModel": "string", 3825 - "penalty": 0, 3826 - "score": 0, 3827 - "totalViolations": 0, 3828 - "violationsByType": { 3829 - "overspeedingViolations": 0, 3830 - "accelerationViolations": 0, 3831 - "brakingViolations": 0, 3832 - "turningViolations": 0, 3833 - "dangerousDrivingViolations": 0, 3834 - "sensorViolations": 0 4305 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4306 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4307 + "vehicleId": 0, ~/~/ ID ТС 4308 + "vehicleName": "string", ~/~/ Название ТС 4309 + "vehicleModel": "string", ~/~/ Модель ТС 4310 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4311 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4312 + "totalViolations": 0, ~/~/ Нарушений всего 4313 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4314 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4315 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4316 + "brakingViolations": 0, ~/~/ Нарушений торможения 4317 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4318 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4319 + "sensorViolations": 0 ~/~/ Нарушений по датчику 3835 3835 }, 3836 - "moveTime": 0, 3837 - "mileage": 0, 3838 - "tripsCount": 0, 3839 - "trips": [ 4321 + 4322 +((( 4323 + 4324 +))) 4325 + 4326 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4327 + "mileage": 0, ~/~/ Пробег, м 4328 + "tripsCount": 0, ~/~/ Кол-во рейсов 4329 + "trips": [ ~/~/ Информация по рейсу 3840 3840 { 3841 - "penalty": 0, 3842 - "score": 0, 3843 - "violationsCount": 0, 3844 - "violationsByType": { 3845 - "overspeedingViolations": 0, 3846 - "accelerationViolations": 0, 3847 - "brakingViolations": 0, 3848 - "turningViolations": 0, 3849 - "dangerousDrivingViolations": 0, 3850 - "sensorViolations": 0 4331 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4332 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4333 + "violationsCount": 0, ~/~/ Всего нарушений 4334 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4335 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4336 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4337 + "brakingViolations": 0, ~/~/ Нарушений торможения 4338 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4339 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4340 + "sensorViolations": 0 ~/~/ Нарушений по датчику 3851 3851 }, 3852 - "moveTime": 0, 3853 - "mileage": 0, 3854 - "motohours": 0, 3855 - "maxSpeed": 0, 3856 - "startAddress": "string", 3857 - "endAddress": "string", 3858 - "drivers": [ 4342 + 4343 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4344 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4345 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4346 + "mileage": 0, ~/~/ Пробег, м 4347 + "motohours": 0, ~/~/ Моточасы, секунды 4348 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4349 + "startAddress": "string", ~/~/ Адрес начала рейса 4350 + "endAddress": "string", ~/~/ Адрес конца рейса 4351 + "drivers": [ ~/~/ Список водителей 3859 3859 { 3860 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3861 - "driverName": "string", 3862 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4353 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4354 + "driverName": "string", ~/~/ФИО водителя 4355 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 3863 3863 } 3864 3864 ] 3865 3865 } ... ... @@ -3868,34 +3868,444 @@ 3868 3868 ] 3869 3869 } 3870 3870 3871 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3872 -|from|Дата начала запроса 3873 -|to|Дата окончания 3874 -|vehicleId|ID объекта 3875 -|vehicleName|Имя объекта 3876 -|vehicleModel|Модель объекта 3877 -|penalty|Сумма штрафных баллов 3878 -|score|Оценка 3879 -|totalViolations|Суммарное количество нарушений 3880 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3881 -|overspeedingViolations|Превышение скорости 3882 -|accelerationViolations|Ускорение 3883 -|brakingViolations|Торможение 3884 -|turningViolations|Резкий поворот 3885 -|dangerousDrivingViolations|Резкое вождение 3886 -|sensorViolations|Нарушение по датчику 3887 -|moveTime|Время в движении 3888 -|mileage|Пробег 3889 -|tripsCount|Количество рейсов 3890 -|motohours|Моточасы 3891 -|maxSpeed|Максимальная скорость 3892 -|startAddress|Адрес начала рейса 3893 -|endAddress|Адрес окончания рейса 3894 -|drivers|Список водителей, которые были на объекте в течениии рейса 3895 -|driverGuid|Guid водителя 3896 -|driverName|Имя водителя 3897 -|driverRfid|Номер Карты-метки 4364 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3898 3898 4366 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4367 + 4368 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4369 + 4370 +(% class="box infomessage" %) 4371 +((( 4372 +POST /api/v3/fuelcards/transactions 4373 +))) 4374 + 4375 +Метод запроса: POST 4376 + 4377 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4378 +\\В заголовках запроса: X-Auth: Токен авторизации 4379 + 4380 +Параметры в теле запроса (JSON): 4381 + 4382 +{ 4383 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4384 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4385 + "ids": [ 4386 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4387 + ], 4388 + "timezone": 0 ~/~/Таймзона 4389 +} 4390 + 4391 + 4392 +Ответ: 4393 + { 4394 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4395 + "driver": "string", ~/~/Водители, привязанные к ТК 4396 + "object": "string", ~/~/Наименование ТС 4397 + "amount": 0, ~/~/Количество топлива 4398 + "amountDut": 0, ~/~/Количество по ДУТ 4399 + "amountDiff": 0, ~/~/Разница, л 4400 + "amountDiffPerc": 0, ~/~/Разница, % 4401 + "summa": 0, ~/~/Стоимость, руб 4402 + "serviceName": "string", ~/~/Тип топлива 4403 + "price": 0, ~/~/Цена за литр, руб 4404 + "cardName": "string", ~/~/Наименование ТК 4405 + "cardNum": "string", ~/~/Номер ТК 4406 + "operator": "string", ~/~/Оператор ТК 4407 + "address": "string" ~/~/Адрес АЗС 4408 + } 4409 + 4410 + 4411 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4412 + 4413 + 4414 +== **Получение полных данных о ретрансляторе** == 4415 + 4416 +(% class="box infomessage" %) 4417 +((( 4418 +**GET ** **/api/v3/retranslations/{id}** 4419 +))) 4420 + 4421 +Идентификатор запроса: ID 4422 + 4423 + 4424 +Пример ответа: 4425 + 4426 +{ 4427 +"description": "", ~/~/ Определяет описание 4428 +"subscriberId": "", ~/~/ Подписчик 4429 +"protocolType": 0, ~/~/ Тип протокола 4430 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4431 +"address": "string", ~/~/ Адрес события 4432 +"objects": [ ~/~/Объекты для ретрансляции 4433 +{ 4434 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4435 +"name": "", ~/~/ Наименование объекта ретрансляции 4436 +"imei": "", ~/~/ IMEI объекта 4437 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4438 +} 4439 + ], 4440 +"id": "", ~/~/ идентификатор пользователя 4441 +"parentId": "", ~/~/Guid родителя 4442 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4443 +} 4444 + 4445 + 4446 +== **Удаление данных ретранслятора** == 4447 + 4448 +(% class="box infomessage" %) 4449 +((( 4450 +**DELETE** **/api/v3/retranslations/{id}** 4451 +))) 4452 + 4453 +Параметр запроса: ID 4454 + 4455 + 4456 +== **Создание ретранслятора** == 4457 + 4458 +(% class="box infomessage" %) 4459 +((( 4460 +**POST ** **/api/v3/retranslations/{id}** 4461 +))) 4462 + 4463 +Запрос: 4464 + 4465 +{ 4466 +"description": "", ~/~/ Описание 4467 +"subscriberId": "", ~/~/ Подписчик 4468 +"protocolType": 0, ~/~/ Тип протокола 4469 +"address": "", ~/~/ Адрес ретрансляции 4470 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4471 +"objects": [ ~/~/Объекты для ретрансляции 4472 +{ 4473 +"id": "", ~/~/ идентификатор пользователя 4474 +"imei": "", ~/~/IMEI объекта 4475 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4476 +} 4477 + ] 4478 +} 4479 + 4480 + 4481 +Ответ: 4482 + 4483 +{ 4484 +"description": "string", ~/~/ Определяет описание 4485 +"subscriberId": "", ~/~/ идентификатор запроса 4486 +"protocolType": 0, ~/~/ Тип протокола 4487 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4488 +"address": "", ~/~/ Адрес события 4489 +"objects": [ ~/~/Объекты для ретрансляции 4490 +{ 4491 +"id": "", ~/~/ идентификатор пользователя 4492 +"name": "string", ~/~/ Название уведомления 4493 +"imei": "string", ~/~/IMEI объекта 4494 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4495 +} 4496 + ], 4497 +"id": "", ~/~/ идентификатор пользователя 4498 +"parentId": "", ~/~/ Guid идентификатор родителя 4499 +"deleted": true ~/~/ Признак удаления 4500 +} 4501 + 4502 + 4503 +== **Редактирование ретранслятора** == 4504 + 4505 +(% class="box infomessage" %) 4506 +((( 4507 +**PUT** **/api/v3/retranslations** 4508 +))) 4509 + 4510 +Пример запроса: 4511 + 4512 +{ 4513 +"id": "", ~/~/ идентификатор пользователя 4514 +"description": "string", ~/~/ Определяет описание 4515 +"subscriberId": "", ~/~/ идентификатор запроса 4516 +"protocolType": 0, ~/~/ Тип протокола 4517 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4518 +"address": "string", ~/~/ Адрес события 4519 +"objects": ~/~/Объекты для ретрансляции 4520 +[ 4521 +{ 4522 +"id": "", ~/~/ идентификатор пользователя 4523 +"imei": "", ~/~/IMEI объекта 4524 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4525 +} 4526 + ] 4527 +} 4528 + 4529 + 4530 +Пример ответа: 4531 + 4532 +{ 4533 +"description": "", ~/~/ Определяет описание 4534 +"subscriberId": "", ~/~/ идентификатор запроса 4535 +"protocolType": 0, ~/~/ Тип протокола 4536 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4537 +"address": "string", ~/~/ Адрес события 4538 +"objects": [ ~/~/Объекты для ретрансляции 4539 +{ 4540 +"id": "", ~/~/ идентификатор пользователя 4541 +"name": "string", ~/~/ Название уведомления 4542 +"imei": "", ~/~/IMEI объекта 4543 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4544 +} 4545 + ], 4546 +"id": "", ~/~/ идентификатор пользователя 4547 +"parentId": "", ~/~/ Guid идентификатор родителя 4548 +"deleted": true ~/~/ Признак удаления 4549 +} 4550 + 4551 + 4552 +== **Получение списка ретранслятора клиента** == 4553 + 4554 +(% class="box infomessage" %) 4555 +((( 4556 +**POST /api/v3/retranslations/find** 4557 +))) 4558 + 4559 +Пример запроса: 4560 + 4561 +{ 4562 +"id": "", ~/~/ идентификатор пользователя 4563 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4564 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4565 +} 4566 + 4567 +Ответ: 4568 + 4569 +[ 4570 +{ 4571 +"description": "", ~/~/ Определяет описание 4572 +"subscriberId": "", ~/~/ идентификатор запроса 4573 +"protocolType": 0, ~/~/ Тип протокола 4574 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4575 +"address": "string", ~/~/ Адрес события 4576 +"id": "", ~/~/ идентификатор пользователя 4577 +"parentId": "", ~/~/ Guid идентификатор родителя 4578 +"deleted": true ~/~/ Признак удаления 4579 +} 4580 +] 4581 + 4582 + 4583 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4584 + 4585 +== **API для отчета по выгрузке комбайнов** == 4586 + 4587 +(% class="box infomessage" %) 4588 +((( 4589 +POST **/api/v3/Reports/harvesterUnloading** 4590 +))) 4591 + 4592 +Пример запроса: 4593 + 4594 +{ 4595 + "byTime": 0, ~/~/ Объединение событий по времени 4596 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4597 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4598 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4599 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4600 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4601 + 0 4602 + ], 4603 + "from": "", ~/~/ Дата и время начало запроса 4604 + "to": "", ~/~/ Дата и время окончания запроса 4605 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4606 +} 4607 + 4608 +Пример ответа: 4609 + 4610 +[ 4611 + { 4612 + "harvesterName": "", ~/~/Комбайн, номер 4613 + "harvesterId": 0, ~/~/Комбайн, id 4614 +"harvesterModel": "", ~/~/ Модель комбайна 4615 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4616 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4617 + "events": [ ~/~/Список событий в разрезе комбайна 4618 + { 4619 + "driverId": "", ~/~/Идентификатор водителя 4620 + "driverName": "", ~/~/Водитель комбайна, ФИО 4621 + "RFID": "", ~/~/ идентификатор карты-метки 4622 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4623 + "vehicleId": 0, ~/~/идентификатор объекта 4624 + "vehicleName": "string", ~/~/ Имя объекта 4625 + "modelName": "string", ~/~/ Имя модели объекта 4626 + "nearestVehicles": [ ~/~/Объекты рядом 4627 + { 4628 + "vehicleId": 0, ~/~/идентификатор объекта 4629 + "vehicleName": "string" ~/~/ Имя объекта 4630 + } 4631 + ], 4632 + "fields": [ ~/~/Поля, где происходила выгрузка 4633 + { 4634 + "id": 0, ~/~/ идентификатор пользователя 4635 + "name": "string" ~/~/ имя пользователя 4636 + } 4637 + ], 4638 + "event": "string", ~/~/Событие 4639 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4640 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4641 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4642 + "cultureName": "string", ~/~/ название культуры 4643 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4644 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4645 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4646 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4647 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4648 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4649 + "issued": 0, ~/~/Выдано, бункеров 4650 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4651 + "latitude": 0, ~/~/Широта 4652 + "longitude": 0, ~/~/ Долгота 4653 + "litresAway": 0, ~/~/Отдано, л 4654 + "m3Away": 0 ~/~/Отдано, м3 4655 + } 4656 + ] 4657 + } 4658 +] 4659 + 4660 + 4661 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4662 + 4663 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4664 + 4665 + 4666 +(% class="box infomessage" %) 4667 +((( 4668 +GET api/v3/Vehicles/recyclebin/all 4669 +))) 4670 + 4671 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4672 + 4673 +Параметр запроса: {parentId} - идентификатор агента 4674 + 4675 +В заголовках запроса: X-Auth: Токен авторизации 4676 + 4677 +Ответ: 4678 + 4679 +[ 4680 + { 4681 + "recordTime": "", ~/~/Время записи 4682 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4683 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4684 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4685 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4686 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4687 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4688 + "items": [ ~/~/ 4689 +nullable: true ~/~/Детали 4690 + { 4691 + "name": "string", ~/~/наименование столбца 4692 + "value": "string" ~/~/содержание столбца 4693 + } 4694 + ] 4695 + }, 4696 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4697 + "string" 4698 + ] 4699 + } 4700 +] 4701 + 4702 + 4703 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4704 + 4705 +(% class="box infomessage" %) 4706 +((( 4707 +POST/api/v3/Vehicles/recyclebin/erase 4708 +))) 4709 + 4710 +В заголовках запроса: X-Auth: Токен авторизации 4711 + 4712 +Пример запроса: 4713 + 4714 +[ 4715 +0 4716 +] 4717 + 4718 + 4719 +Пример ответа: 4720 + 4721 +[ 4722 +{ 4723 + "recordTime": "", ~/~/Время записи 4724 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4725 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4726 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4727 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4728 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4729 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4730 + "items": [ ~/~/Детали 4731 + { 4732 + "name": "", ~/~/Имя свойства 4733 + "value": "" ~/~/Значение свойства 4734 + } 4735 + ] 4736 + }, 4737 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4738 + "" 4739 + ] 4740 + } 4741 +] 4742 + 4743 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4744 + 4745 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4746 + 4747 +(% class="box infomessage" %) 4748 +((( 4749 +POST/api/v3/Vehicles/recyclebin/restore 4750 +))) 4751 + 4752 +В заголовках запроса: X-Auth: Токен авторизации 4753 + 4754 +Параметры в теле запроса (JSON): 4755 + 4756 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4757 + 4758 +В заголовках запроса: X-Auth: Токен авторизации 4759 + 4760 + 4761 +Пример запроса: 4762 + 4763 +((( 4764 +[ 4765 +))) 4766 + 4767 +((( 4768 + 0 4769 +))) 4770 + 4771 +((( 4772 +] 4773 +))) 4774 + 4775 + 4776 +Пример ответа: 4777 + 4778 +[ 4779 +{ 4780 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4781 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4782 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4783 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4784 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4785 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4786 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4787 + "items": [ ~/~/Детали 4788 + { 4789 + "name": "string", ~/~/Имя свойства 4790 + "value": "string" ~/~/Значение свойства 4791 + } 4792 + ] 4793 + }, 4794 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4795 + "string" 4796 + ] 4797 + } 4798 +] 4799 + 4800 + 4801 + 3899 3899 (% class="box" lang="en-US" style="text-align: center;" %) 3900 3900 ((( 3901 3901 (% 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]] **