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,33 +1334,25 @@ 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 1361 "summaryMaxValue": 0 ~/~/ Макс. значение 1362 1362 } 1363 1363 ], 1378 + 1379 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1380 + 1381 + 1364 1364 "customFields": [ ~/~/ Произвольные поля 1365 1365 { 1366 1366 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1375,55 +1375,157 @@ 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 - однократно) 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 ~/~/ Условие по количеству записей для деактивации 1416 1416 } 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 +))) 1417 1417 1418 -(% style="text-align:left" %) 1419 -(% 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 +))) 1420 1420 1540 + 1421 1421 **Валидация:** 1422 1422 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1423 1423 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1424 1424 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1425 1425 1426 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1546 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1427 1427 1428 1428 (% class="box infomessage" %) 1429 1429 ((( ... ... @@ -1430,7 +1430,7 @@ 1430 1430 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1431 1431 ))) 1432 1432 1433 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1553 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1434 1434 1435 1435 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1436 1436 ... ... @@ -1474,8 +1474,7 @@ 1474 1474 (% style="color:#000000" %)Ответ: 1475 1475 1476 1476 (% style="color:#000000" %){ 1477 - 1478 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1597 + "vehicleId": "" ~/~/ идентификатор объекта 1479 1479 "name": "" ~/~/ наименование объекта 1480 1480 "imei": "" ~/~/ IMEI объекта 1481 1481 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -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 - 1660 +(% 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 1669 +== == 1670 + 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": [ ~/~/ Датчики 1758 +"sensors": [ ~/~/ Датчики 1643 1643 { 1644 1644 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1645 1645 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1677,33 +1677,26 @@ 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 ~/~/ Макс. значение 1705 1705 } 1706 1706 ], 1811 + 1812 +((( 1813 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1814 +))) 1815 + 1707 1707 "customFields": [ ~/~/ Произвольные поля 1708 1708 { 1709 1709 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1718,54 +1718,175 @@ 1718 1718 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" %){ 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 +))) 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 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": [ ~/~/ Тарировка 1744 1744 { 1745 - "id": ~/~/ идентификатор 1746 - "enabled": true, ~/~/ флаг включения 1747 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1748 - "login": "", ~/~/ имя учетной записи 1749 - "password": "", ~/~/ пароль учетной записи 1750 - } 1751 - "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": [ ~/~/ Интервалы значений для подсветки в мониторинге 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": "", ~/~/ Сколько раз выполнить задание 1977 + "from": 0, ~/~/ С какого значения 1978 + "color": "string", ~/~/ Каким цветом 1979 + "text": "string" ~/~/ Текст подписи к этому интервалу 1764 1764 } 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 +))) 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]]2037 +(% 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 - 2043 +(% 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 - 2067 +(% 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|Номер входа 2157 +|inputNumber|((( 2158 +Номер входа 2159 +))) 1934 1934 2161 +(% class="wikigeneratedid" %) 2162 +Перечень 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/]] 2163 + 1935 1935 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1936 1936 1937 1937 (% class="box infomessage" %) ... ... @@ -2040,10 +2040,12 @@ 2040 2040 { 2041 2041 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2042 2042 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2043 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2044 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2045 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2046 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2272 + "mileage": 0, ~/~/ Пробег за период, километры 2273 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2274 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2275 + "motohours": 0, ~/~/ Моточасы за период, секунды 2276 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2277 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2047 2047 } 2048 2048 ] 2049 2049 } ... ... @@ -2092,6 +2092,12 @@ 2092 2092 } 2093 2093 ] 2094 2094 2326 +(% class="box warningmessage" %) 2327 +((( 2328 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2329 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2330 +))) 2331 + 2095 2095 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2096 2096 2097 2097 (% class="box infomessage" %) ... ... @@ -2137,6 +2137,96 @@ 2137 2137 } 2138 2138 ] 2139 2139 2377 + 2378 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2379 + 2380 +(% class="box infomessage" %) 2381 +((( 2382 +**POST /api/v3/vehicles/moveStop** 2383 +))) 2384 + 2385 +Метод запроса: **POST** 2386 + 2387 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2388 + 2389 +В заголовках запроса: X-Auth: Токен авторизации 2390 + 2391 + 2392 +Тело запроса: 2393 + 2394 +{ 2395 + "vehicleIds": [ ], ~/~/ Список ID объектов 2396 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2397 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2398 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2399 +} 2400 + 2401 +Ответ: 2402 + 2403 +[ 2404 + { 2405 + "vehicleId": 0, ~/~/ ID объекта 2406 + "vehicleName": "string", ~/~/ Имя объекта 2407 + "moves": [ ~/~/ Событие движения 2408 + { 2409 + "mileage": 0, ~/~/ Пробег, км 2410 + "eventId": 0, ~/~/ Идентификатор события 2411 + "eventName": "string", ~/~/ Название события 2412 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2413 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2414 + "duration": 0 ~/~/ Продолжительность события, секунд 2415 + } 2416 + ], 2417 + "stops": [ ~/~/ События стоянок 2418 + { 2419 + "address": "string", ~/~/ Адрес события 2420 + "eventId": 0, ~/~/ Идентификатор события 2421 + "eventName": "string", ~/~/ Название события 2422 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2423 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2424 + "duration": 0 ~/~/ Продолжительность события, секунд 2425 + } 2426 + ] 2427 + } 2428 +] 2429 + 2430 + 2431 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2432 + 2433 +(% class="box infomessage" %) 2434 +((( 2435 +**POST /api/v3/vehicles/getlastdata** 2436 +))) 2437 + 2438 +Метод запроса: **POST** 2439 + 2440 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2441 + 2442 +В заголовках запроса: X-Auth: Токен авторизации 2443 + 2444 + 2445 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2446 + 2447 +Ответ: 2448 + { 2449 + "vehicleId": 0, ~/~/Идентификатор объекта. 2450 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2451 + "vehicleNumber": "string",~/~/Номер объекта. 2452 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2453 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2454 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2455 + "speed": 0,~/~/Скорость объекта. 2456 + "course": 0,~/~/Курс движения [0;360] 2457 + "latitude": 0,~/~/Широта [-90°;90°]. 2458 + "longitude": 0,~/~/Долгота [-180°;180°]. 2459 + "address": "string",~/~/Адрес. 2460 + "geozones": [ ~/~/Сведения по геозонам. 2461 + { 2462 + "id": 0, 2463 + "name": "string" 2464 + } 2465 + 2466 + 2140 2140 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2141 2141 2142 2142 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2444,6 +2444,32 @@ 2444 2444 2445 2445 Success 2446 2446 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 + 2447 2447 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2448 2448 2449 2449 (% class="box errormessage" %) ... ... @@ -3634,7 +3634,7 @@ 3634 3634 **POST /api/v3/vehicles/import/{agentId}** 3635 3635 ))) 3636 3636 3637 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3990 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3638 3638 3639 3639 В пути указывается **agentId** - id клиента. 3640 3640 ... ... @@ -3646,7 +3646,7 @@ 3646 3646 3647 3647 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3648 3648 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3649 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1- Замена,2- Слияние,3- Добавление4002 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3650 3650 3651 3651 В теле использовать тип **form-data,** тип значения** file** 3652 3652 ... ... @@ -3813,7 +3813,7 @@ 3813 3813 3814 3814 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3815 3815 3816 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==4169 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3817 3817 3818 3818 (% class="box infomessage" %) 3819 3819 ((( ... ... @@ -3908,7 +3908,7 @@ 3908 3908 |dangerousDrivingViolations|Резкое вождение 3909 3909 |sensorViolations|Нарушение по датчику 3910 3910 |moveTime|Время в движении 3911 -|mileage|Пробег 4264 +|mileage|Пробег (км) 3912 3912 |tripsCount|Количество рейсов 3913 3913 |motohours|Моточасы 3914 3914 |maxSpeed|Максимальная скорость ... ... @@ -3919,6 +3919,444 @@ 3919 3919 |driverName|Имя водителя 3920 3920 |driverRfid|Номер Карты-метки 3921 3921 4275 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4276 + 4277 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4278 + 4279 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4280 + 4281 +(% class="box infomessage" %) 4282 +((( 4283 +POST /api/v3/fuelcards/transactions 4284 +))) 4285 + 4286 +Метод запроса: POST 4287 + 4288 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4289 +\\В заголовках запроса: X-Auth: Токен авторизации 4290 + 4291 +Параметры в теле запроса (JSON): 4292 + 4293 +{ 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 +} 4301 + 4302 + 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 + } 4320 + 4321 + 4322 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4323 + 4324 + 4325 +== **Получение полных данных о ретрансляторе** == 4326 + 4327 +(% class="box infomessage" %) 4328 +((( 4329 +**GET ** **/api/v3/retranslations/{id}** 4330 +))) 4331 + 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 - отключен 4349 +} 4350 + ], 4351 +"id": "", ~/~/ идентификатор пользователя 4352 +"parentId": "", ~/~/Guid родителя 4353 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4354 +} 4355 + 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 + 4392 +Ответ: 4393 + 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 +} 4412 + 4413 + 4414 +== **Редактирование ретранслятора** == 4415 + 4416 +(% class="box infomessage" %) 4417 +((( 4418 +**PUT** **/api/v3/retranslations** 4419 +))) 4420 + 4421 +Пример запроса: 4422 + 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 +} 4439 + 4440 + 4441 +Пример ответа: 4442 + 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 +} 4461 + 4462 + 4463 +== **Получение списка ретранслятора клиента** == 4464 + 4465 +(% class="box infomessage" %) 4466 +((( 4467 +**POST /api/v3/retranslations/find** 4468 +))) 4469 + 4470 +Пример запроса: 4471 + 4472 +{ 4473 +"id": "", ~/~/ идентификатор пользователя 4474 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4475 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4476 +} 4477 + 4478 +Ответ: 4479 + 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 + ] 4568 + } 4569 +] 4570 + 4571 + 4572 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4573 + 4574 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4575 + 4576 + 4577 +(% class="box infomessage" %) 4578 +((( 4579 +GET api/v3/Vehicles/recyclebin/all 4580 +))) 4581 + 4582 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4583 + 4584 +Параметр запроса: {parentId} - идентификатор агента 4585 + 4586 +В заголовках запроса: X-Auth: Токен авторизации 4587 + 4588 +Ответ: 4589 + 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 +] 4612 + 4613 + 4614 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4615 + 4616 +(% class="box infomessage" %) 4617 +((( 4618 +POST/api/v3/Vehicles/recyclebin/erase 4619 +))) 4620 + 4621 +В заголовках запроса: X-Auth: Токен авторизации 4622 + 4623 +Пример запроса: 4624 + 4625 +[ 4626 +0 4627 +] 4628 + 4629 + 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 + 4654 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4655 + 4656 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4657 + 4658 +(% class="box infomessage" %) 4659 +((( 4660 +POST/api/v3/Vehicles/recyclebin/restore 4661 +))) 4662 + 4663 +В заголовках запроса: X-Auth: Токен авторизации 4664 + 4665 +Параметры в теле запроса (JSON): 4666 + 4667 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4668 + 4669 +В заголовках запроса: X-Auth: Токен авторизации 4670 + 4671 + 4672 +Пример запроса: 4673 + 4674 +((( 4675 +[ 4676 +))) 4677 + 4678 +((( 4679 + 0 4680 +))) 4681 + 4682 +((( 4683 +] 4684 +))) 4685 + 4686 + 4687 +Пример ответа: 4688 + 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 +] 4710 + 4711 + 4712 + 3922 3922 (% class="box" lang="en-US" style="text-align: center;" %) 3923 3923 ((( 3924 3924 (% 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]] **