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
-
... ... @@ -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 - Договор) ... ... @@ -356,6 +356,21 @@ 356 356 357 357 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 358 358 357 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 358 + 359 +(% class="box warningmessage" %) 360 +((( 361 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 362 +))) 363 + 364 +Метод позволяет изменить статус клиента, указанного в запросе. 365 + 366 +В пути указывается GUID клиента и статус клиента. 367 + 368 +**status **- значение 0 - заблокирован, 1 - активен. 369 + 370 +Ответ: Code 204 371 + 359 359 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 360 360 361 361 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -1789,7 +1789,7 @@ 1789 1789 1790 1790 (% style="color:#000000" %)Метод запроса: **GET** 1791 1791 1792 -(% 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]]1805 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1793 1793 1794 1794 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1795 1795 ... ... @@ -1872,6 +1872,51 @@ 1872 1872 } 1873 1873 ] 1874 1874 1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1889 + 1890 +(% class="box infomessage" style="text-align: left;" %) 1891 +((( 1892 +**POST /api/v3/terminalMessages/mapping** 1893 +))) 1894 + 1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1896 + 1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1898 + 1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1900 + 1901 +{ 1902 + "protocolType": 0, 1903 + "params": ["string"] 1904 +} 1905 + 1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1907 +|protocolType|ID типа протокола 1908 +|params|((( 1909 +Массив наименований параметров в сообщении 1910 +))) 1911 + 1912 +Ответ: 1913 + 1914 +{ 1915 + "protocolType": 0, 1916 + "mapping": { 1917 + "additionalProp1": { 1918 + "inputType": 0, 1919 + "inputNumber": 0 1920 + }, 1921 + "additionalProp2": { 1922 + "inputType": 0, 1923 + "inputNumber": 0 1924 + } 1925 + } 1926 +} 1927 + 1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1929 +|protocolType|Тип протокола 1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1931 +|inputNumber|Номер входа 1932 + 1875 1875 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1876 1876 1877 1877 (% class="box infomessage" %) ... ... @@ -1896,6 +1896,11 @@ 1896 1896 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1897 1897 } 1898 1898 1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1958 +|vehicleId|ID объекта 1959 +|from|Дата и время начала периода запроса 1960 +|to|Дата и время окончания периода запроса 1961 + 1899 1899 Ответ: 1900 1900 1901 1901 [ ... ... @@ -1902,25 +1902,43 @@ 1902 1902 { 1903 1903 "messages": [ 1904 1904 { 1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1907 - "speed": 0, ~/~/ Скорость, км/ч 1908 - "altitude": 0, ~/~/ Высота, м 1909 - "latitude": 0, ~/~/ Широта [-90°;90°] 1910 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1911 - "satellites": 0, ~/~/ Кол-во спутников 1912 - "voltage": 0, ~/~/ Напряжение 1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1968 + "deviceTime": "2023-11-29T07:40:44.052Z", 1969 + "serverTime": "2023-11-29T07:40:44.052Z", 1970 + "speed": 0, 1971 + "altitude": 0, 1972 + "latitude": 0, 1973 + "longitude": 0, 1974 + "satellites": 0, 1975 + "course": 0, 1976 + "voltage": 0, 1977 + "parameters": { 1914 1914 "additionalProp1": "string", 1915 1915 "additionalProp2": "string", 1916 1916 "additionalProp3": "string" 1917 1917 }, 1918 - "photoCount": 0 ~/~/ Кол-во фото 1982 + "photoCount": 0, 1983 + "lbsCorrectedCoords": true, 1984 + "protocolType": 0 1919 1919 } 1920 1920 ] 1921 1921 } 1922 1922 ] 1923 1923 1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1991 +|deviceTime|Время сообщения терминала 1992 +|serverTime|Время когда сообщение поступило на сервер 1993 +|speed|Скорость 1994 +|altitude|Высота над уровнем моря 1995 +|latitude|Широта 1996 +|longitude|Долгота 1997 +|satellites|Кол-во спутников 1998 +|course|Курс 1999 +|voltage|Бортовое напряжение 2000 +|parameters|Список параметров и их значений 2001 +|photoCount|Количество фото 2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2003 +|protocolType|ID типа протокола 2004 + 1924 1924 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1925 1925 1926 1926 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2054,6 +2054,92 @@ 2054 2054 } 2055 2055 ] 2056 2056 2138 + 2139 +(% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов** 2140 + 2141 + 2142 +(% class="box infomessage" %) 2143 +((( 2144 +**POST/api/v3/vehicles/moveStop** 2145 +))) 2146 + 2147 +Метод запроса: **POST** 2148 + 2149 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/moveStop]] 2150 + 2151 +В заголовках запроса: X-Auth: Токен авторизации 2152 + 2153 + 2154 +Тело запроса: 2155 + 2156 +{ 2157 + 2158 + "vehicleIds": [ ], ~/~/ Список ID объектов 2159 + 2160 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2161 + 2162 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2163 + 2164 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2165 + 2166 +} 2167 + 2168 + 2169 +Ответ: 2170 + 2171 +[ 2172 + 2173 + { 2174 + 2175 + "vehicleId": 0, ~/~/ ID объекта 2176 + 2177 + "vehicleName": "string", ~/~/ Имя объекта 2178 + 2179 + "moves": [ ~/~/ Событие движения 2180 + 2181 + { 2182 + 2183 + "mileage": 0, ~/~/ Пробег, км 2184 + 2185 + "eventId": 0, ~/~/ Идентификатор события 2186 + 2187 + "eventName": "string", ~/~/ Название события 2188 + 2189 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2190 + 2191 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2192 + 2193 + "duration": 0 ~/~/ Продолжительность события, секунд 2194 + 2195 + } 2196 + 2197 + ], 2198 + 2199 + "stops": [ ~/~/ События стоянок 2200 + 2201 + { 2202 + 2203 + "address": "string", ~/~/ Адрес события 2204 + 2205 + "eventId": 0, ~/~/ Идентификатор события 2206 + 2207 + "eventName": "string", ~/~/ Название события 2208 + 2209 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2210 + 2211 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2212 + 2213 + "duration": 0 ~/~/ Продолжительность события, секунд 2214 + 2215 + 2216 + } 2217 + 2218 + ] 2219 + 2220 + } 2221 + 2222 +] 2223 + 2057 2057 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2058 2058 2059 2059 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -3551,7 +3551,7 @@ 3551 3551 **POST /api/v3/vehicles/import/{agentId}** 3552 3552 ))) 3553 3553 3554 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** 3721 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3555 3555 3556 3556 В пути указывается **agentId** - id клиента. 3557 3557 ... ... @@ -3565,7 +3565,7 @@ 3565 3565 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3566 3566 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3567 3567 3568 -В теле использовать тип **form-data,** тип значения** 3735 +В теле использовать тип **form-data,** тип значения** file** 3569 3569 3570 3570 **Ключи** 3571 3571 ... ... @@ -3586,11 +3586,11 @@ 3586 3586 |name|Имя созданного объекта 3587 3587 |errors|Ошибки и их описание 3588 3588 3589 -(% style="color:#000000; font-size:16px" %)**Импорт сообщений** 3756 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3590 3590 3591 3591 (% class="box infomessage" %) 3592 3592 ((( 3593 -**POST /api/v3/vehicles/import/history/{vehicleId}** 3760 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3594 3594 ))) 3595 3595 3596 3596 (% class="wikigeneratedid" %) ... ... @@ -3730,7 +3730,7 @@ 3730 3730 3731 3731 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3732 3732 3733 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==3900 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3734 3734 3735 3735 (% class="box infomessage" %) 3736 3736 (((