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 - Договор) ... ... @@ -1804,7 +1804,7 @@ 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]]1805 +(% 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 ... ... @@ -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|Номер входа 1931 +|inputNumber|((( 1932 +Номер входа 1933 +))) 1934 1934 1935 +(% class="wikigeneratedid" %) 1936 +Перечень 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/]] 1937 + 1935 1935 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1936 1936 1937 1937 (% class="box infomessage" %) ... ... @@ -1956,6 +1956,11 @@ 1956 1956 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1957 1957 } 1958 1958 1962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1963 +|vehicleId|ID объекта 1964 +|from|Дата и время начала периода запроса 1965 +|to|Дата и время окончания периода запроса 1966 + 1959 1959 Ответ: 1960 1960 1961 1961 [ ... ... @@ -1962,25 +1962,43 @@ 1962 1962 { 1963 1963 "messages": [ 1964 1964 { 1965 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1966 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1967 - "speed": 0, ~/~/ Скорость, км/ч 1968 - "altitude": 0, ~/~/ Высота, м 1969 - "latitude": 0, ~/~/ Широта [-90°;90°] 1970 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1971 - "satellites": 0, ~/~/ Кол-во спутников 1972 - "voltage": 0, ~/~/ Напряжение 1973 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1973 + "deviceTime": "2023-11-29T07:40:44.052Z", 1974 + "serverTime": "2023-11-29T07:40:44.052Z", 1975 + "speed": 0, 1976 + "altitude": 0, 1977 + "latitude": 0, 1978 + "longitude": 0, 1979 + "satellites": 0, 1980 + "course": 0, 1981 + "voltage": 0, 1982 + "parameters": { 1974 1974 "additionalProp1": "string", 1975 1975 "additionalProp2": "string", 1976 1976 "additionalProp3": "string" 1977 1977 }, 1978 - "photoCount": 0 ~/~/ Кол-во фото 1987 + "photoCount": 0, 1988 + "lbsCorrectedCoords": true, 1989 + "protocolType": 0 1979 1979 } 1980 1980 ] 1981 1981 } 1982 1982 ] 1983 1983 1995 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1996 +|deviceTime|Время сообщения терминала 1997 +|serverTime|Время когда сообщение поступило на сервер 1998 +|speed|Скорость 1999 +|altitude|Высота над уровнем моря 2000 +|latitude|Широта 2001 +|longitude|Долгота 2002 +|satellites|Кол-во спутников 2003 +|course|Курс 2004 +|voltage|Бортовое напряжение 2005 +|parameters|Список параметров и их значений 2006 +|photoCount|Количество фото 2007 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2008 +|protocolType|ID типа протокола 2009 + 1984 1984 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1985 1985 1986 1986 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2114,6 +2114,129 @@ 2114 2114 } 2115 2115 ] 2116 2116 2143 + 2144 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2145 + 2146 +(% class="box infomessage" %) 2147 +((( 2148 +**POST /api/v3/vehicles/moveStop** 2149 +))) 2150 + 2151 +Метод запроса: **POST** 2152 + 2153 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2154 + 2155 +В заголовках запроса: X-Auth: Токен авторизации 2156 + 2157 + 2158 +Тело запроса: 2159 + 2160 +{ 2161 + 2162 + "vehicleIds": [ ], ~/~/ Список ID объектов 2163 + 2164 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2165 + 2166 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2167 + 2168 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2169 + 2170 +} 2171 + 2172 +Ответ: 2173 + 2174 +[ 2175 + 2176 + { 2177 + 2178 + "vehicleId": 0, ~/~/ ID объекта 2179 + 2180 + "vehicleName": "string", ~/~/ Имя объекта 2181 + 2182 + "moves": [ ~/~/ Событие движения 2183 + 2184 + { 2185 + 2186 + "mileage": 0, ~/~/ Пробег, км 2187 + 2188 + "eventId": 0, ~/~/ Идентификатор события 2189 + 2190 + "eventName": "string", ~/~/ Название события 2191 + 2192 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2193 + 2194 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2195 + 2196 + "duration": 0 ~/~/ Продолжительность события, секунд 2197 + 2198 + } 2199 + 2200 + ], 2201 + 2202 + "stops": [ ~/~/ События стоянок 2203 + 2204 + { 2205 + 2206 + "address": "string", ~/~/ Адрес события 2207 + 2208 + "eventId": 0, ~/~/ Идентификатор события 2209 + 2210 + "eventName": "string", ~/~/ Название события 2211 + 2212 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2213 + 2214 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2215 + 2216 + "duration": 0 ~/~/ Продолжительность события, секунд 2217 + 2218 + 2219 + } 2220 + 2221 + ] 2222 + 2223 + } 2224 + 2225 +] 2226 + 2227 + 2228 + 2229 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2230 + 2231 +(% class="box infomessage" %) 2232 +((( 2233 +**POST /api/v3/vehicles/getlastdata** 2234 +))) 2235 + 2236 +Метод запроса: **POST** 2237 + 2238 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2239 + 2240 +В заголовках запроса: X-Auth: Токен авторизации 2241 + 2242 + 2243 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2244 + 2245 +Ответ: 2246 + { 2247 + "vehicleId": 0, ~/~/Идентификатор объекта. 2248 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2249 + "vehicleNumber": "string",~/~/Номер объекта. 2250 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2251 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2252 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2253 + "speed": 0,~/~/Скорость объекта. 2254 + "course": 0,~/~/Курс движения [0;360] 2255 + "latitude": 0,~/~/Широта [-90°;90°]. 2256 + "longitude": 0,~/~/Долгота [-180°;180°]. 2257 + "address": "string",~/~/Адрес. 2258 + "geozones": [ ~/~/Сведения по геозонам. 2259 + { 2260 + "id": 0, 2261 + "name": "string" 2262 + } 2263 + 2264 + 2265 + 2117 2117 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2118 2118 2119 2119 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -3790,7 +3790,7 @@ 3790 3790 3791 3791 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3792 3792 3793 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин ша качества вождения**(%%) ==3942 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3794 3794 3795 3795 (% class="box infomessage" %) 3796 3796 ((( ... ... @@ -3896,6 +3896,73 @@ 3896 3896 |driverName|Имя водителя 3897 3897 |driverRfid|Номер Карты-метки 3898 3898 4048 + 4049 +(% style="color:#000000; font-size:18.6667px" %)Раздел: Топливные карты 4050 + 4051 +===== **Запрос транзакций по топливным картам** ===== 4052 + 4053 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК» 4054 + 4055 +(% class="box infomessage" %) 4056 +((( 4057 +**POST**/api/v3/fuelcards/transactions 4058 +))) 4059 + 4060 +Запрос должен содержать параметры: 4061 + 4062 +{ 4063 + 4064 + "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения 4065 + 4066 + "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения 4067 + 4068 + "ids": [ 4069 + 4070 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт 4071 + 4072 + ], 4073 + 4074 + "timezone": 0, ~/~/ Часовой пояс 4075 + 4076 + "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца 4077 + 4078 +} 4079 + 4080 +Ответ: 4081 + 4082 + { 4083 + 4084 + "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции 4085 + 4086 + " driver ": "string", ~/~/ Имя водителя 4087 + 4088 + "amount": 0, ~/~/ Количество топлива 4089 + 4090 + "amountDut": 0, ~/~/ Количество топлива по ДУТ 4091 + 4092 + "amountDiff": 0, ~/~/ Разница в литрах 4093 + 4094 + "amountDiffPerc": 0, ~/~/ Разница в % 4095 + 4096 + "summa": 0, ~/~/ Стоимость в руб. 4097 + 4098 + "serviceName": "string", ~/~/ Тип топлива 4099 + 4100 + "price": 0, ~/~/ Цена за литр в руб. 4101 + 4102 + "cardName": "string", ~/~/ Наименование ТК 4103 + 4104 + "cardNum": "string", ~/~/ Номер ТК 4105 + 4106 + "operator": "string", ~/~/ Оператор ТК 4107 + 4108 + "address": "string", ~/~/ Адрес АЗС 4109 + 4110 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid топливной карты 4111 + 4112 + } 4113 + 4114 + 3899 3899 (% class="box" lang="en-US" style="text-align: center;" %) 3900 3900 ((( 3901 3901 (% 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]] **