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.SupportZhuchkov - 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,29 +1334,17 @@ 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 } ... ... @@ -1375,8 +1375,7 @@ 1375 1375 1376 1376 (% style="color:#000000" %)Ответ: 1377 1377 1378 -(% style="color:#000000" %){ 1379 - 1392 +(% style="color:#000000" %){(%%) 1380 1380 "vehicleId": "", ~/~/ID ТС 1381 1381 "parentId": "", ~/~/Guid владельца ТС 1382 1382 "name": "", ~/~/Имя объекта ... ... @@ -1414,8 +1414,6 @@ 1414 1414 "kind": "", ~/~/ Вид периодичности по времени 1415 1415 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1416 1416 } 1417 - 1418 -(% style="text-align:left" %) 1419 1419 (% style="color:#000000" %)} 1420 1420 1421 1421 **Валидация:** ... ... @@ -1423,7 +1423,7 @@ 1423 1423 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1424 1424 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1425 1425 1426 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1437 +== (% 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, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1444 +(% 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": "" ~/~/ идентификатор объекта 1488 + "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 - 1551 +(% 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 1560 +== == 1561 + 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": [ ~/~/ Датчики 1649 +"sensors": [ ~/~/ Датчики 1643 1643 { 1644 1644 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1645 1645 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1677,29 +1677,17 @@ 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 } ... ... @@ -1719,9 +1719,7 @@ 1719 1719 (% style="color:#000000" %)Ответ: 1720 1720 1721 1721 (% lang="en-US" style="text-align:left" %) 1722 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1723 - 1724 -(% lang="en-US" style="text-align:left" %) 1717 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1725 1725 "vehicleId": "", ~/~/ ID ТС 1726 1726 "parentId": "", ~/~/ ID клиента 1727 1727 "name": "", ~/~/ имя ТС ... ... @@ -1762,8 +1762,6 @@ 1762 1762 "kind": "", ~/~/ Вид периодичности по времени 1763 1763 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1764 1764 } 1765 - 1766 -(% lang="en-US" style="text-align:left" %) 1767 1767 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1768 1768 1769 1769 **Валидация:** ... ... @@ -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]]1798 +(% 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 - 1804 +(% 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 - 1828 +(% 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" %)Раздел: **Сообщения**(%%) = ... ... @@ -1887,6 +1887,56 @@ 1887 1887 } 1888 1888 ] 1889 1889 1875 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1876 + 1877 +(% class="box infomessage" style="text-align: left;" %) 1878 +((( 1879 +**POST /api/v3/terminalMessages/mapping** 1880 +))) 1881 + 1882 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1883 + 1884 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1885 + 1886 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1887 + 1888 +{ 1889 + "protocolType": 0, 1890 + "params": ["string"] 1891 +} 1892 + 1893 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1894 +|protocolType|ID типа протокола 1895 +|params|((( 1896 +Массив наименований параметров в сообщении 1897 +))) 1898 + 1899 +Ответ: 1900 + 1901 +{ 1902 + "protocolType": 0, 1903 + "mapping": { 1904 + "additionalProp1": { 1905 + "inputType": 0, 1906 + "inputNumber": 0 1907 + }, 1908 + "additionalProp2": { 1909 + "inputType": 0, 1910 + "inputNumber": 0 1911 + } 1912 + } 1913 +} 1914 + 1915 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1916 +|protocolType|Тип протокола 1917 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1918 +|inputNumber|((( 1919 +Номер входа 1920 +))) 1921 + 1922 +(% class="wikigeneratedid" %) 1923 +Перечень 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/]] 1924 + 1890 1890 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1891 1891 1892 1892 (% class="box infomessage" %) ... ... @@ -1911,6 +1911,11 @@ 1911 1911 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1912 1912 } 1913 1913 1949 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1950 +|vehicleId|ID объекта 1951 +|from|Дата и время начала периода запроса 1952 +|to|Дата и время окончания периода запроса 1953 + 1914 1914 Ответ: 1915 1915 1916 1916 [ ... ... @@ -1917,25 +1917,43 @@ 1917 1917 { 1918 1918 "messages": [ 1919 1919 { 1920 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1921 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1922 - "speed": 0, ~/~/ Скорость, км/ч 1923 - "altitude": 0, ~/~/ Высота, м 1924 - "latitude": 0, ~/~/ Широта [-90°;90°] 1925 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1926 - "satellites": 0, ~/~/ Кол-во спутников 1927 - "voltage": 0, ~/~/ Напряжение 1928 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1960 + "deviceTime": "2023-11-29T07:40:44.052Z", 1961 + "serverTime": "2023-11-29T07:40:44.052Z", 1962 + "speed": 0, 1963 + "altitude": 0, 1964 + "latitude": 0, 1965 + "longitude": 0, 1966 + "satellites": 0, 1967 + "course": 0, 1968 + "voltage": 0, 1969 + "parameters": { 1929 1929 "additionalProp1": "string", 1930 1930 "additionalProp2": "string", 1931 1931 "additionalProp3": "string" 1932 1932 }, 1933 - "photoCount": 0 ~/~/ Кол-во фото 1974 + "photoCount": 0, 1975 + "lbsCorrectedCoords": true, 1976 + "protocolType": 0 1934 1934 } 1935 1935 ] 1936 1936 } 1937 1937 ] 1938 1938 1982 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1983 +|deviceTime|Время сообщения терминала 1984 +|serverTime|Время когда сообщение поступило на сервер 1985 +|speed|Скорость 1986 +|altitude|Высота над уровнем моря 1987 +|latitude|Широта 1988 +|longitude|Долгота 1989 +|satellites|Кол-во спутников 1990 +|course|Курс 1991 +|voltage|Бортовое напряжение 1992 +|parameters|Список параметров и их значений 1993 +|photoCount|Количество фото 1994 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 1995 +|protocolType|ID типа протокола 1996 + 1939 1939 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1940 1940 1941 1941 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1972,10 +1972,12 @@ 1972 1972 { 1973 1973 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1974 1974 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1975 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1976 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1977 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1978 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2033 + "mileage": 0, ~/~/ Пробег за период, километры 2034 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2035 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2036 + "motohours": 0, ~/~/ Моточасы за период, секунды 2037 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2038 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1979 1979 } 1980 1980 ] 1981 1981 } ... ... @@ -2024,6 +2024,12 @@ 2024 2024 } 2025 2025 ] 2026 2026 2087 +(% class="box warningmessage" %) 2088 +((( 2089 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2090 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2091 +))) 2092 + 2027 2027 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2028 2028 2029 2029 (% class="box infomessage" %) ... ... @@ -2069,6 +2069,96 @@ 2069 2069 } 2070 2070 ] 2071 2071 2138 + 2139 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2140 + 2141 +(% class="box infomessage" %) 2142 +((( 2143 +**POST /api/v3/vehicles/moveStop** 2144 +))) 2145 + 2146 +Метод запроса: **POST** 2147 + 2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2149 + 2150 +В заголовках запроса: X-Auth: Токен авторизации 2151 + 2152 + 2153 +Тело запроса: 2154 + 2155 +{ 2156 + "vehicleIds": [ ], ~/~/ Список ID объектов 2157 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2158 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2159 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2160 +} 2161 + 2162 +Ответ: 2163 + 2164 +[ 2165 + { 2166 + "vehicleId": 0, ~/~/ ID объекта 2167 + "vehicleName": "string", ~/~/ Имя объекта 2168 + "moves": [ ~/~/ Событие движения 2169 + { 2170 + "mileage": 0, ~/~/ Пробег, км 2171 + "eventId": 0, ~/~/ Идентификатор события 2172 + "eventName": "string", ~/~/ Название события 2173 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2174 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2175 + "duration": 0 ~/~/ Продолжительность события, секунд 2176 + } 2177 + ], 2178 + "stops": [ ~/~/ События стоянок 2179 + { 2180 + "address": "string", ~/~/ Адрес события 2181 + "eventId": 0, ~/~/ Идентификатор события 2182 + "eventName": "string", ~/~/ Название события 2183 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2184 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2185 + "duration": 0 ~/~/ Продолжительность события, секунд 2186 + } 2187 + ] 2188 + } 2189 +] 2190 + 2191 + 2192 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2193 + 2194 +(% class="box infomessage" %) 2195 +((( 2196 +**POST /api/v3/vehicles/getlastdata** 2197 +))) 2198 + 2199 +Метод запроса: **POST** 2200 + 2201 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2202 + 2203 +В заголовках запроса: X-Auth: Токен авторизации 2204 + 2205 + 2206 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2207 + 2208 +Ответ: 2209 + { 2210 + "vehicleId": 0, ~/~/Идентификатор объекта. 2211 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2212 + "vehicleNumber": "string",~/~/Номер объекта. 2213 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2214 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2215 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2216 + "speed": 0,~/~/Скорость объекта. 2217 + "course": 0,~/~/Курс движения [0;360] 2218 + "latitude": 0,~/~/Широта [-90°;90°]. 2219 + "longitude": 0,~/~/Долгота [-180°;180°]. 2220 + "address": "string",~/~/Адрес. 2221 + "geozones": [ ~/~/Сведения по геозонам. 2222 + { 2223 + "id": 0, 2224 + "name": "string" 2225 + } 2226 + 2227 + 2072 2072 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2073 2073 2074 2074 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2376,6 +2376,32 @@ 2376 2376 2377 2377 Success 2378 2378 2535 + 2536 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2537 + 2538 +(% class="box warningmessage" %) 2539 +((( 2540 +**PUT** /api/v3/notifications/prolongation 2541 +))) 2542 + 2543 +Метод позволяет продлить уведомления. 2544 + 2545 +Метод запроса **PUT** 2546 + 2547 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2548 + 2549 +В заголовках запроса: X-Auth: Токен авторизации. 2550 + 2551 +Тело запроса: 2552 + 2553 +[ 2554 + 2555 +0 2556 + 2557 +] 2558 + 2559 +где 0 идентификатор ids. 2560 + 2379 2379 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2380 2380 2381 2381 (% class="box errormessage" %) ... ... @@ -3566,7 +3566,7 @@ 3566 3566 **POST /api/v3/vehicles/import/{agentId}** 3567 3567 ))) 3568 3568 3569 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3751 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3570 3570 3571 3571 В пути указывается **agentId** - id клиента. 3572 3572 ... ... @@ -3578,7 +3578,7 @@ 3578 3578 3579 3579 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3580 3580 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3581 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1- Замена,2- Слияние,3- Добавление3763 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3582 3582 3583 3583 В теле использовать тип **form-data,** тип значения** file** 3584 3584 ... ... @@ -3745,7 +3745,7 @@ 3745 3745 3746 3746 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3747 3747 3748 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==3930 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3749 3749 3750 3750 (% class="box infomessage" %) 3751 3751 ((( ... ... @@ -3840,7 +3840,7 @@ 3840 3840 |dangerousDrivingViolations|Резкое вождение 3841 3841 |sensorViolations|Нарушение по датчику 3842 3842 |moveTime|Время в движении 3843 -|mileage|Пробег 4025 +|mileage|Пробег (км) 3844 3844 |tripsCount|Количество рейсов 3845 3845 |motohours|Моточасы 3846 3846 |maxSpeed|Максимальная скорость ... ... @@ -3851,6 +3851,444 @@ 3851 3851 |driverName|Имя водителя 3852 3852 |driverRfid|Номер Карты-метки 3853 3853 4036 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4037 + 4038 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4039 + 4040 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4041 + 4042 +(% class="box infomessage" %) 4043 +((( 4044 +POST /api/v3/fuelcards/transactions 4045 +))) 4046 + 4047 +Метод запроса: POST 4048 + 4049 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4050 +\\В заголовках запроса: X-Auth: Токен авторизации 4051 + 4052 +Параметры в теле запроса (JSON): 4053 + 4054 +{ 4055 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4056 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4057 + "ids": [ 4058 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4059 + ], 4060 + "timezone": 0 ~/~/Таймзона 4061 +} 4062 + 4063 + 4064 +Ответ: 4065 + { 4066 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4067 + "driver": "string", ~/~/Водители, привязанные к ТК 4068 + "object": "string", ~/~/Наименование ТС 4069 + "amount": 0, ~/~/Количество топлива 4070 + "amountDut": 0, ~/~/Количество по ДУТ 4071 + "amountDiff": 0, ~/~/Разница, л 4072 + "amountDiffPerc": 0, ~/~/Разница, % 4073 + "summa": 0, ~/~/Стоимость, руб 4074 + "serviceName": "string", ~/~/Тип топлива 4075 + "price": 0, ~/~/Цена за литр, руб 4076 + "cardName": "string", ~/~/Наименование ТК 4077 + "cardNum": "string", ~/~/Номер ТК 4078 + "operator": "string", ~/~/Оператор ТК 4079 + "address": "string" ~/~/Адрес АЗС 4080 + } 4081 + 4082 + 4083 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4084 + 4085 + 4086 +== **Получение полных данных о ретрансляторе** == 4087 + 4088 +(% class="box infomessage" %) 4089 +((( 4090 +**GET ** **/api/v3/retranslations/{id}** 4091 +))) 4092 + 4093 +Идентификатор запроса: ID 4094 + 4095 + 4096 +Пример ответа: 4097 + 4098 +{ 4099 +"description": "", ~/~/ Определяет описание 4100 +"subscriberId": "", ~/~/ Подписчик 4101 +"protocolType": 0, ~/~/ Тип протокола 4102 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4103 +"address": "string", ~/~/ Адрес события 4104 +"objects": [ ~/~/Объекты для ретрансляции 4105 +{ 4106 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4107 +"name": "", ~/~/ Наименование объекта ретрансляции 4108 +"imei": "", ~/~/ IMEI объекта 4109 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4110 +} 4111 + ], 4112 +"id": "", ~/~/ идентификатор пользователя 4113 +"parentId": "", ~/~/Guid родителя 4114 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4115 +} 4116 + 4117 + 4118 +== **Удаление данных ретранслятора** == 4119 + 4120 +(% class="box infomessage" %) 4121 +((( 4122 +**DELETE** **/api/v3/retranslations/{id}** 4123 +))) 4124 + 4125 +Параметр запроса: ID 4126 + 4127 + 4128 +== **Создание ретранслятора** == 4129 + 4130 +(% class="box infomessage" %) 4131 +((( 4132 +**POST ** **/api/v3/retranslations/{id}** 4133 +))) 4134 + 4135 +Запрос: 4136 + 4137 +{ 4138 +"description": "", ~/~/ Описание 4139 +"subscriberId": "", ~/~/ Подписчик 4140 +"protocolType": 0, ~/~/ Тип протокола 4141 +"address": "", ~/~/ Адрес ретрансляции 4142 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4143 +"objects": [ ~/~/Объекты для ретрансляции 4144 +{ 4145 +"id": "", ~/~/ идентификатор пользователя 4146 +"imei": "", ~/~/IMEI объекта 4147 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4148 +} 4149 + ] 4150 +} 4151 + 4152 + 4153 +Ответ: 4154 + 4155 +{ 4156 +"description": "string", ~/~/ Определяет описание 4157 +"subscriberId": "", ~/~/ идентификатор запроса 4158 +"protocolType": 0, ~/~/ Тип протокола 4159 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4160 +"address": "", ~/~/ Адрес события 4161 +"objects": [ ~/~/Объекты для ретрансляции 4162 +{ 4163 +"id": "", ~/~/ идентификатор пользователя 4164 +"name": "string", ~/~/ Название уведомления 4165 +"imei": "string", ~/~/IMEI объекта 4166 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4167 +} 4168 + ], 4169 +"id": "", ~/~/ идентификатор пользователя 4170 +"parentId": "", ~/~/ Guid идентификатор родителя 4171 +"deleted": true ~/~/ Признак удаления 4172 +} 4173 + 4174 + 4175 +== **Редактирование ретранслятора** == 4176 + 4177 +(% class="box infomessage" %) 4178 +((( 4179 +**PUT** **/api/v3/retranslations** 4180 +))) 4181 + 4182 +Пример запроса: 4183 + 4184 +{ 4185 +"id": "", ~/~/ идентификатор пользователя 4186 +"description": "string", ~/~/ Определяет описание 4187 +"subscriberId": "", ~/~/ идентификатор запроса 4188 +"protocolType": 0, ~/~/ Тип протокола 4189 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4190 +"address": "string", ~/~/ Адрес события 4191 +"objects": ~/~/Объекты для ретрансляции 4192 +[ 4193 +{ 4194 +"id": "", ~/~/ идентификатор пользователя 4195 +"imei": "", ~/~/IMEI объекта 4196 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4197 +} 4198 + ] 4199 +} 4200 + 4201 + 4202 +Пример ответа: 4203 + 4204 +{ 4205 +"description": "", ~/~/ Определяет описание 4206 +"subscriberId": "", ~/~/ идентификатор запроса 4207 +"protocolType": 0, ~/~/ Тип протокола 4208 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4209 +"address": "string", ~/~/ Адрес события 4210 +"objects": [ ~/~/Объекты для ретрансляции 4211 +{ 4212 +"id": "", ~/~/ идентификатор пользователя 4213 +"name": "string", ~/~/ Название уведомления 4214 +"imei": "", ~/~/IMEI объекта 4215 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4216 +} 4217 + ], 4218 +"id": "", ~/~/ идентификатор пользователя 4219 +"parentId": "", ~/~/ Guid идентификатор родителя 4220 +"deleted": true ~/~/ Признак удаления 4221 +} 4222 + 4223 + 4224 +== **Получение списка ретранслятора клиента** == 4225 + 4226 +(% class="box infomessage" %) 4227 +((( 4228 +**POST /api/v3/retranslations/find** 4229 +))) 4230 + 4231 +Пример запроса: 4232 + 4233 +{ 4234 +"id": "", ~/~/ идентификатор пользователя 4235 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4236 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4237 +} 4238 + 4239 +Ответ: 4240 + 4241 +[ 4242 +{ 4243 +"description": "", ~/~/ Определяет описание 4244 +"subscriberId": "", ~/~/ идентификатор запроса 4245 +"protocolType": 0, ~/~/ Тип протокола 4246 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4247 +"address": "string", ~/~/ Адрес события 4248 +"id": "", ~/~/ идентификатор пользователя 4249 +"parentId": "", ~/~/ Guid идентификатор родителя 4250 +"deleted": true ~/~/ Признак удаления 4251 +} 4252 +] 4253 + 4254 + 4255 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4256 + 4257 +== **API для отчета по выгрузке комбайнов** == 4258 + 4259 +(% class="box infomessage" %) 4260 +((( 4261 +POST **/api/v3/Reports/harvesterUnloading** 4262 +))) 4263 + 4264 +Пример запроса: 4265 + 4266 +{ 4267 + "byTime": 0, ~/~/ Объединение событий по времени 4268 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4269 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4270 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4271 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4272 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4273 + 0 4274 + ], 4275 + "from": "", ~/~/ Дата и время начало запроса 4276 + "to": "", ~/~/ Дата и время окончания запроса 4277 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4278 +} 4279 + 4280 +Пример ответа: 4281 + 4282 +[ 4283 + { 4284 + "harvesterName": "", ~/~/Комбайн, номер 4285 + "harvesterId": 0, ~/~/Комбайн, id 4286 +"harvesterModel": "", ~/~/ Модель комбайна 4287 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4288 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4289 + "events": [ ~/~/Список событий в разрезе комбайна 4290 + { 4291 + "driverId": "", ~/~/Идентификатор водителя 4292 + "driverName": "", ~/~/Водитель комбайна, ФИО 4293 + "RFID": "", ~/~/ идентификатор карты-метки 4294 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4295 + "vehicleId": 0, ~/~/идентификатор объекта 4296 + "vehicleName": "string", ~/~/ Имя объекта 4297 + "modelName": "string", ~/~/ Имя модели объекта 4298 + "nearestVehicles": [ ~/~/Объекты рядом 4299 + { 4300 + "vehicleId": 0, ~/~/идентификатор объекта 4301 + "vehicleName": "string" ~/~/ Имя объекта 4302 + } 4303 + ], 4304 + "fields": [ ~/~/Поля, где происходила выгрузка 4305 + { 4306 + "id": 0, ~/~/ идентификатор пользователя 4307 + "name": "string" ~/~/ имя пользователя 4308 + } 4309 + ], 4310 + "event": "string", ~/~/Событие 4311 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4312 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4313 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4314 + "cultureName": "string", ~/~/ название культуры 4315 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4316 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4317 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4318 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4319 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4320 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4321 + "issued": 0, ~/~/Выдано, бункеров 4322 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4323 + "latitude": 0, ~/~/Широта 4324 + "longitude": 0, ~/~/ Долгота 4325 + "litresAway": 0, ~/~/Отдано, л 4326 + "m3Away": 0 ~/~/Отдано, м3 4327 + } 4328 + ] 4329 + } 4330 +] 4331 + 4332 + 4333 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4334 + 4335 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4336 + 4337 + 4338 +(% class="box infomessage" %) 4339 +((( 4340 +GET api/v3/Vehicles/recyclebin/all 4341 +))) 4342 + 4343 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4344 + 4345 +Параметр запроса: {parentId} - идентификатор агента 4346 + 4347 +В заголовках запроса: X-Auth: Токен авторизации 4348 + 4349 +Ответ: 4350 + 4351 +[ 4352 + { 4353 + "recordTime": "", ~/~/Время записи 4354 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4355 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4356 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4357 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4358 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4359 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4360 + "items": [ ~/~/ 4361 +nullable: true ~/~/Детали 4362 + { 4363 + "name": "string", ~/~/наименование столбца 4364 + "value": "string" ~/~/содержание столбца 4365 + } 4366 + ] 4367 + }, 4368 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4369 + "string" 4370 + ] 4371 + } 4372 +] 4373 + 4374 + 4375 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4376 + 4377 +(% class="box infomessage" %) 4378 +((( 4379 +POST/api/v3/Vehicles/recyclebin/erase 4380 +))) 4381 + 4382 +В заголовках запроса: X-Auth: Токен авторизации 4383 + 4384 +Пример запроса: 4385 + 4386 +[ 4387 +0 4388 +] 4389 + 4390 + 4391 +Пример ответа: 4392 + 4393 +[ 4394 +{ 4395 + "recordTime": "", ~/~/Время записи 4396 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4397 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4398 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4399 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4400 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4401 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4402 + "items": [ ~/~/Детали 4403 + { 4404 + "name": "", ~/~/Имя свойства 4405 + "value": "" ~/~/Значение свойства 4406 + } 4407 + ] 4408 + }, 4409 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4410 + "" 4411 + ] 4412 + } 4413 +] 4414 + 4415 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4416 + 4417 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4418 + 4419 +(% class="box infomessage" %) 4420 +((( 4421 +POST/api/v3/Vehicles/recyclebin/restore 4422 +))) 4423 + 4424 +В заголовках запроса: X-Auth: Токен авторизации 4425 + 4426 +Параметры в теле запроса (JSON): 4427 + 4428 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4429 + 4430 +В заголовках запроса: X-Auth: Токен авторизации 4431 + 4432 + 4433 +Пример запроса: 4434 + 4435 +((( 4436 +[ 4437 +))) 4438 + 4439 +((( 4440 + 0 4441 +))) 4442 + 4443 +((( 4444 +] 4445 +))) 4446 + 4447 + 4448 +Пример ответа: 4449 + 4450 +[ 4451 +{ 4452 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4453 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4454 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4455 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4456 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4457 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4458 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4459 + "items": [ ~/~/Детали 4460 + { 4461 + "name": "string", ~/~/Имя свойства 4462 + "value": "string" ~/~/Значение свойства 4463 + } 4464 + ] 4465 + }, 4466 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4467 + "string" 4468 + ] 4469 + } 4470 +] 4471 + 4472 + 4473 + 3854 3854 (% class="box" lang="en-US" style="text-align: center;" %) 3855 3855 ((( 3856 3856 (% 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]] **