Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
<
>
edited by Андрей Калиновский
on 2024/07/19 13:24
on 2024/07/19 13:24
edited by Андрей Калиновский
on 2024/02/28 09:55
on 2024/02/28 09:55
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -60,9 +60,6 @@ 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 63 -(% class="wikigeneratedid" %) 64 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 65 - 66 66 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 67 67 68 68 (% class="box infomessage" %) ... ... @@ -1431,7 +1431,7 @@ 1431 1431 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1432 1432 ))) 1433 1433 1434 -(% style="color:#000000" %)Метод позволяет получить список доступныхобъектовмониторинга (транспортных средств)с их основнымипараметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1431 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1435 1435 1436 1436 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1437 1437 ... ... @@ -1931,13 +1931,8 @@ 1931 1931 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1932 1932 |protocolType|Тип протокола 1933 1933 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1934 -|inputNumber|((( 1935 -Номер входа 1936 -))) 1931 +|inputNumber|Номер входа 1937 1937 1938 -(% class="wikigeneratedid" %) 1939 -Перечень 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/]] 1940 - 1941 1941 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1942 1942 1943 1943 (% class="box infomessage" %) ... ... @@ -2243,8 +2243,21 @@ 2243 2243 В заголовках запроса: X-Auth: Токен авторизации 2244 2244 2245 2245 2246 - В телезапросаперечисляете массив id объектов, в квадратных скобках через запятую.2238 +Тело запроса: 2247 2247 2240 +{ 2241 + 2242 + "vehicleIds": [ ], ~/~/ Список ID машины 2243 + 2244 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2245 + 2246 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2247 + 2248 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2249 + 2250 +} 2251 + 2252 + 2248 2248 Ответ: 2249 2249 { 2250 2250 "vehicleId": 0, ~/~/Идентификатор объекта. ... ... @@ -2252,7 +2252,7 @@ 2252 2252 "vehicleNumber": "string",~/~/Номер объекта. 2253 2253 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2254 2254 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2255 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нетданных - 0; отключена- 1;остановка- 2;стоянка- 3; в движении-4.2260 + "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных. 2256 2256 "speed": 0,~/~/Скорость объекта. 2257 2257 "course": 0,~/~/Курс движения [0;360] 2258 2258 "latitude": 0,~/~/Широта [-90°;90°]. ... ... @@ -4048,273 +4048,6 @@ 4048 4048 |driverName|Имя водителя 4049 4049 |driverRfid|Номер Карты-метки 4050 4050 4051 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4052 - 4053 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4054 - 4055 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4056 - 4057 -(% class="box infomessage" %) 4058 -((( 4059 -POST /api/v3/fuelcards/transactions 4060 -))) 4061 - 4062 -Метод запроса: POST 4063 - 4064 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4065 -\\В заголовках запроса: X-Auth: Токен авторизации 4066 - 4067 -Параметры в теле запроса (JSON): 4068 - 4069 -{ 4070 - 4071 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4072 - 4073 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4074 - 4075 - "ids": [ 4076 - 4077 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4078 - 4079 - ], 4080 - 4081 - "timezone": 0 ~/~/Таймзона 4082 - 4083 -} 4084 - 4085 -Ответ: 4086 - 4087 - { 4088 - 4089 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4090 - 4091 - "driver": "string", ~/~/Водители, привязанные к ТК 4092 - 4093 - "object": "string", ~/~/Наименование ТС 4094 - 4095 - "amount": 0, ~/~/Количество топлива 4096 - 4097 - "amountDut": 0, ~/~/Количество по ДУТ 4098 - 4099 - "amountDiff": 0, ~/~/Разница, л 4100 - 4101 - "amountDiffPerc": 0, ~/~/Разница, % 4102 - 4103 - "summa": 0, ~/~/Стоимость, руб 4104 - 4105 - "serviceName": "string", ~/~/Тип топлива 4106 - 4107 - "price": 0, ~/~/Цена за литр, руб 4108 - 4109 - "cardName": "string", ~/~/Наименование ТК 4110 - 4111 - "cardNum": "string", ~/~/Номер ТК 4112 - 4113 - "operator": "string", ~/~/Оператор ТК 4114 - 4115 - "address": "string" ~/~/Адрес АЗС 4116 - 4117 - } 4118 - 4119 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4120 - 4121 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4122 - 4123 - 4124 -(% class="box infomessage" %) 4125 -((( 4126 -GET api/v3/Vehicles/recyclebin/all 4127 -))) 4128 - 4129 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4130 - 4131 -Параметр запроса: {parentId} - идентификатор агента 4132 - 4133 -В заголовках запроса: X-Auth: Токен авторизации 4134 - 4135 -Ответ: 4136 - 4137 -[ 4138 - 4139 - { 4140 - 4141 - "recordTime": "", ~/~/Время записи 4142 - 4143 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4144 - 4145 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4146 - 4147 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4148 - 4149 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4150 - 4151 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4152 - 4153 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4154 - 4155 - "items": [ ~/~/ [ 4156 - 4157 -nullable: true ~/~/Детали 4158 - 4159 - { 4160 - 4161 - "name": "string", ~/~/наименование столбца 4162 - 4163 - "value": "string" ~/~/содержание столбца 4164 - 4165 - } 4166 - 4167 - ] 4168 - 4169 - }, 4170 - 4171 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4172 - 4173 - "string" 4174 - 4175 - ] 4176 - 4177 - } 4178 - 4179 -] 4180 - 4181 - 4182 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4183 - 4184 -(% class="box infomessage" %) 4185 -((( 4186 -POST/api/v3/Vehicles/recyclebin/erase 4187 -))) 4188 - 4189 -В заголовках запроса: X-Auth: Токен авторизации 4190 - 4191 -Пример запроса: 4192 - 4193 - 4194 -[ 4195 - 4196 - 0 4197 - 4198 -] 4199 - 4200 - 4201 -Пример ответа: 4202 - 4203 -[ 4204 - 4205 - { 4206 - 4207 - "recordTime": "", ~/~/Время записи 4208 - 4209 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4210 - 4211 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4212 - 4213 - "objectId": 0, ~/~/ID объекта, помещённого в корзин 4214 - 4215 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4216 - 4217 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4218 - 4219 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4220 - 4221 - "items": [ ~/~/Детали 4222 - 4223 - { 4224 - 4225 - "name": "", ~/~/Имя свойства 4226 - 4227 - "value": "" ~/~/Значение свойства 4228 - 4229 - } 4230 - 4231 - ] 4232 - 4233 - }, 4234 - 4235 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4236 - 4237 - "" 4238 - 4239 - ] 4240 - 4241 - } 4242 - 4243 -] 4244 - 4245 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4246 - 4247 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4248 - 4249 -(% class="box infomessage" %) 4250 -((( 4251 -POST/api/v3/Vehicles/recyclebin/restore 4252 -))) 4253 - 4254 -В заголовках запроса: X-Auth: Токен авторизации 4255 - 4256 -Параметры в теле запроса (JSON): 4257 - 4258 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4259 - 4260 -В заголовках запроса: X-Auth: Токен авторизации 4261 - 4262 - 4263 -Пример запроса: 4264 - 4265 -[ 4266 - 4267 - 0 4268 - 4269 -] 4270 - 4271 - 4272 -Пример ответа: 4273 - 4274 -[ 4275 - 4276 - { 4277 - 4278 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4279 - 4280 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4281 - 4282 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4283 - 4284 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4285 - 4286 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4287 - 4288 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4289 - 4290 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4291 - 4292 - "items": [ ~/~/Детали 4293 - 4294 - { 4295 - 4296 - "name": "string", ~/~/Имя свойства 4297 - 4298 - "value": "string" ~/~/Значение свойства 4299 - 4300 - } 4301 - 4302 - ] 4303 - 4304 - }, 4305 - 4306 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4307 - 4308 - "string" 4309 - 4310 - ] 4311 - 4312 - } 4313 - 4314 -] 4315 - 4316 - 4317 - 4318 4318 (% class="box" lang="en-US" style="text-align: center;" %) 4319 4319 ((( 4320 4320 (% 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]] **