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. Gadmin1 +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 ((( ... ... @@ -971,7 +971,7 @@ 971 971 972 972 Ответ: В случае успеха **Success 200** 973 973 974 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 975 975 976 976 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 977 977 ... ... @@ -1163,6 +1163,23 @@ 1163 1163 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1164 1164 1165 1165 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 + 1166 1166 == **Получить ответ на отправленную на ТС команду** == 1167 1167 1168 1168 (% class="box infomessage" %) ... ... @@ -1408,7 +1408,7 @@ 1408 1408 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1409 1409 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1410 1410 1411 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1437 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1412 1412 1413 1413 (% class="box infomessage" %) 1414 1414 ((( ... ... @@ -1531,24 +1531,8 @@ 1531 1531 "stage": "", ~/~/ Состояние 1532 1532 (% style="color:#000000" %) } 1533 1533 1534 -(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1535 -**Отправить команду на терминал** 1560 +== == 1536 1536 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 - 1552 1552 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1553 1553 1554 1554 (% class="box warningmessage" %) ... ... @@ -2020,10 +2020,12 @@ 2020 2020 { 2021 2021 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2022 2022 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2023 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2024 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2025 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2026 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2033 + "mileage": 0, ~/~/ Пробег за период, километры 2034 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2035 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2036 + "motohours": 0, ~/~/ Моточасы за период, секунды 2037 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2038 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2027 2027 } 2028 2028 ] 2029 2029 } ... ... @@ -2072,6 +2072,12 @@ 2072 2072 } 2073 2073 ] 2074 2074 2087 +(% class="box warningmessage" %) 2088 +((( 2089 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2090 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2091 +))) 2092 + 2075 2075 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2076 2076 2077 2077 (% class="box infomessage" %) ... ... @@ -2514,6 +2514,32 @@ 2514 2514 2515 2515 Success 2516 2516 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 + 2517 2517 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2518 2518 2519 2519 (% class="box errormessage" %) ... ... @@ -3704,7 +3704,7 @@ 3704 3704 **POST /api/v3/vehicles/import/{agentId}** 3705 3705 ))) 3706 3706 3707 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3751 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3708 3708 3709 3709 В пути указывается **agentId** - id клиента. 3710 3710 ... ... @@ -3716,7 +3716,7 @@ 3716 3716 3717 3717 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3718 3718 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3719 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1- Замена,2- Слияние,3- Добавление3763 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3720 3720 3721 3721 В теле использовать тип **form-data,** тип значения** file** 3722 3722 ... ... @@ -3978,7 +3978,7 @@ 3978 3978 |dangerousDrivingViolations|Резкое вождение 3979 3979 |sensorViolations|Нарушение по датчику 3980 3980 |moveTime|Время в движении 3981 -|mileage|Пробег 4025 +|mileage|Пробег (км) 3982 3982 |tripsCount|Количество рейсов 3983 3983 |motohours|Моточасы 3984 3984 |maxSpeed|Максимальная скорость