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. SupportZhuchkov1 +XWiki.Gadmin - Content
-
... ... @@ -14,20 +14,11 @@ 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 - 24 24 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 25 25 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 -))) 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 31 31 32 32 (% class="box successmessage" %) 33 33 ((( ... ... @@ -980,7 +980,7 @@ 980 980 981 981 Ответ: В случае успеха **Success 200** 982 982 983 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =974 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 984 984 985 985 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 986 986 ... ... @@ -1172,23 +1172,6 @@ 1172 1172 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1173 1173 1174 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 1192 == **Получить ответ на отправленную на ТС команду** == 1193 1193 1194 1194 (% class="box infomessage" %) ... ... @@ -1434,7 +1434,7 @@ 1434 1434 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1435 1435 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1436 1436 1437 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектовс основными параметрами**(%%) ==1411 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1438 1438 1439 1439 (% class="box infomessage" %) 1440 1440 ((( ... ... @@ -1557,8 +1557,24 @@ 1557 1557 "stage": "", ~/~/ Состояние 1558 1558 (% style="color:#000000" %) } 1559 1559 1560 -== == 1534 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1535 +**Отправить команду на терминал** 1561 1561 1537 +(% class="box successmessage" %) 1538 +((( 1539 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1540 +))) 1541 + 1542 +Команда для отправки на тс. 1543 + 1544 +{ 1545 +"id": "", ~/~/идентификатор произвольного поля 1546 +"command": "", ~/~/ Текст команды 1547 +"retries": "", ~/~/ Количество попыток 1548 +"idTemplate": "" ~/~/ ID шаблона команды 1549 +} 1550 + 1551 + 1562 1562 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1563 1563 1564 1564 (% class="box warningmessage" %) ... ... @@ -2030,12 +2030,10 @@ 2030 2030 { 2031 2031 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2032 2032 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2033 - "mileage": 0, ~/~/ Пробег за период, километры 2034 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2035 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2036 - "motohours": 0, ~/~/ Моточасы за период, секунды 2037 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2038 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2023 + "mileageBegin": 0, ~/~/ Пробег на начало периода 2024 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 2025 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2026 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2039 2039 } 2040 2040 ] 2041 2041 } ... ... @@ -2084,12 +2084,6 @@ 2084 2084 } 2085 2085 ] 2086 2086 2087 -(% class="box warningmessage" %) 2088 -((( 2089 -Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2090 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2091 -))) 2092 - 2093 2093 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2094 2094 2095 2095 (% class="box infomessage" %) ... ... @@ -2532,32 +2532,6 @@ 2532 2532 2533 2533 Success 2534 2534 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 - 2561 2561 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2562 2562 2563 2563 (% class="box errormessage" %) ... ... @@ -3748,7 +3748,7 @@ 3748 3748 **POST /api/v3/vehicles/import/{agentId}** 3749 3749 ))) 3750 3750 3751 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение*.xls)**или **wlp. **Также они могут находится в** zip-архиве(один файл - один архив).**3707 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3752 3752 3753 3753 В пути указывается **agentId** - id клиента. 3754 3754 ... ... @@ -3760,7 +3760,7 @@ 3760 3760 3761 3761 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3762 3762 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3763 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace- Замена,Merge- Слияние,Add- Добавление3719 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3764 3764 3765 3765 В теле использовать тип **form-data,** тип значения** file** 3766 3766 ... ... @@ -4022,7 +4022,7 @@ 4022 4022 |dangerousDrivingViolations|Резкое вождение 4023 4023 |sensorViolations|Нарушение по датчику 4024 4024 |moveTime|Время в движении 4025 -|mileage|Пробег (км)3981 +|mileage|Пробег 4026 4026 |tripsCount|Количество рейсов 4027 4027 |motohours|Моточасы 4028 4028 |maxSpeed|Максимальная скорость