Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/14 11:58
<
>
edited by Андрей Калиновский
on 2024/11/22 13:26
on 2024/11/22 13:26
edited by Андрей Калиновский
on 2024/11/14 16:13
on 2024/11/14 16:13
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,9 +1,11 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 -**Содержание страницы:** \3 +**Содержание страницы:** 4 4 ))) 5 5 6 +{{toc/}} 6 6 8 + 7 7 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 8 8 9 9 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). ... ... @@ -1170,77 +1170,6 @@ 1170 1170 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1171 1171 1172 1172 1173 -== **Импортировать историю ТС (Асинхронный запрос)** == 1174 - 1175 -(% class="box successmessage" %) 1176 -((( 1177 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1178 -))) 1179 - 1180 -(% style="color:#000000" %)Метод запроса: **POST** 1181 - 1182 -(% style="color:#000000" %)URL запроса: (%%)**https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1183 - 1184 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства 1185 - 1186 - 1187 -Ответ: 1188 - 1189 -{ 1190 - 1191 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1192 - 1193 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1194 - 1195 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1196 - 1197 - "Message": "string", ~/~/ Информация о выполнении запроса 1198 - 1199 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1200 - 1201 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1202 - 1203 - "Data": "string" ~/~/ Данные 1204 - 1205 -} 1206 - 1207 - 1208 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1209 - 1210 -(% class="box infomessage" %) 1211 -((( 1212 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1213 -))) 1214 - 1215 -(% style="color:#000000" %)Метод запроса: **GET** 1216 - 1217 -(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1218 - 1219 -(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса 1220 - 1221 - 1222 -Ответ: 1223 - 1224 -{ 1225 - 1226 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1227 - 1228 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1229 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1230 - 1231 - "Message": "string", ~/~/ Информация о выполнении запроса 1232 - 1233 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1234 - 1235 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1236 - 1237 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1238 - 1239 - "Data": "string" ~/~/ Данные 1240 - 1241 -} 1242 - 1243 - 1244 1244 == **Отправить команду на терминал** == 1245 1245 1246 1246 (% class="box successmessage" %) ... ... @@ -1667,12 +1667,9 @@ 1667 1667 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1668 1668 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1669 1669 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1670 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1671 - "unitName": "string", ~/~/ Название подразделения (опционально) 1672 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1673 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1674 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1675 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1601 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 1602 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1603 + "customFields": null ~/~/ значение любого из произвольных полей ТС 1676 1676 } 1677 1677 1678 1678 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1679,15 +1679,8 @@ 1679 1679 1680 1680 (% style="color:#000000" %)Ответ: 1681 1681 1682 -(% style="color:#000000" %)[ 1683 -{ 1684 - 1685 -((( 1686 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1687 -))) 1688 - 1689 -((( 1690 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1610 +(% style="color:#000000" %){ 1611 + "vehicleId": "" ~/~/ идентификатор объекта 1691 1691 "name": "" ~/~/ наименование объекта 1692 1692 "imei": "" ~/~/ IMEI объекта 1693 1693 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1712,21 +1712,9 @@ 1712 1712 "forClient": true, ~/~/ право на отображение у клиента 1713 1713 "forTooltip": false, ~/~/ право на отображение в подсказке 1714 1714 "forReport": false ~/~/ право на отображение в отчетах 1715 -))) 1636 + }(%%) 1637 +(% style="color:#000000" %)} 1716 1716 1717 -((( 1718 - } 1719 - ], 1720 - "vehicleGroups": [ ~/~/ Группы ТС 1721 - { 1722 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1723 - "name": "string" ~/~/ Наименование группы ТС 1724 - } 1725 - ] 1726 - } 1727 -] 1728 -))) 1729 - 1730 1730 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1731 1731 1732 1732 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -4289,67 +4289,64 @@ 4289 4289 Тело запроса: 4290 4290 4291 4291 { 4292 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов4293 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса4294 - "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса4201 + "vehicleIds": [vehicleId], 4202 + "from": "2023-11-22T09:29:48.051Z", 4203 + "to": "2023-11-22T09:29:48.051Z" 4295 4295 } 4296 4296 4206 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4207 +|vehicleIds|Массив ID объектов 4208 +|from|Дата начала запроса 4209 +|to|Дата окончания запроса 4210 + 4297 4297 Ответ: 4298 4298 4299 4299 { 4300 - "items": [ ~/~/ Список в разрезе ТС4214 + "items": [ 4301 4301 { 4302 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода4303 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода4304 - "vehicleId": 0, ~/~/ ID ТС4305 - "vehicleName": "string", ~/~/ Название ТС4306 - "vehicleModel": "string", ~/~/ Модель ТС4307 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС4308 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС4309 - "totalViolations": 0, ~/~/ Нарушений всего4310 - "violationsByType": { ~/~/ Информация о нарушениях по типу4311 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости4312 - "accelerationViolations": 0, ~/~/ Нарушений ускорения4313 - "brakingViolations": 0, ~/~/ Нарушений торможения4314 - "turningViolations": 0, ~/~/ Нарушений опасного поворота4315 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения4316 - "sensorViolations": 0 ~/~/ Нарушений по датчику4216 + "from": "2023-11-22T09:29:48.052Z", 4217 + "to": "2023-11-22T09:29:48.052Z", 4218 + "vehicleId": 0, 4219 + "vehicleName": "string", 4220 + "vehicleModel": "string", 4221 + "penalty": 0, 4222 + "score": 0, 4223 + "totalViolations": 0, 4224 + "violationsByType": { 4225 + "overspeedingViolations": 0, 4226 + "accelerationViolations": 0, 4227 + "brakingViolations": 0, 4228 + "turningViolations": 0, 4229 + "dangerousDrivingViolations": 0, 4230 + "sensorViolations": 0 4317 4317 }, 4318 - 4319 -((( 4320 - 4321 -))) 4322 - 4323 - "moveTime": 0, ~/~/ Продолжительность движения, сек 4324 - "mileage": 0, ~/~/ Пробег, м 4325 - "tripsCount": 0, ~/~/ Кол-во рейсов 4326 - "trips": [ ~/~/ Информация по рейсу 4232 + "moveTime": 0, 4233 + "mileage": 0, 4234 + "tripsCount": 0, 4235 + "trips": [ 4327 4327 { 4328 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс4329 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс4330 - "violationsCount": 0, ~/~/ Всего нарушений4331 - "violationsByType": { ~/~/ Информация о нарушениях по типу4332 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости4333 - "accelerationViolations": 0, ~/~/ Нарушений ускорения4334 - "brakingViolations": 0, ~/~/ Нарушений торможения4335 - "turningViolations": 0, ~/~/ Нарушений опасного поворота4336 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения4337 - "sensorViolations": 0 ~/~/ Нарушений по датчику4237 + "penalty": 0, 4238 + "score": 0, 4239 + "violationsCount": 0, 4240 + "violationsByType": { 4241 + "overspeedingViolations": 0, 4242 + "accelerationViolations": 0, 4243 + "brakingViolations": 0, 4244 + "turningViolations": 0, 4245 + "dangerousDrivingViolations": 0, 4246 + "sensorViolations": 0 4338 4338 }, 4339 - 4340 - "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4341 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4342 - "moveTime": 0, ~/~/ Продолжительность движения, сек 4343 - "mileage": 0, ~/~/ Пробег, м 4344 - "motohours": 0, ~/~/ Моточасы, секунды 4345 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4346 - "startAddress": "string", ~/~/ Адрес начала рейса 4347 - "endAddress": "string", ~/~/ Адрес конца рейса 4348 - "drivers": [ ~/~/ Список водителей 4248 + "moveTime": 0, 4249 + "mileage": 0, 4250 + "motohours": 0, 4251 + "maxSpeed": 0, 4252 + "startAddress": "string", 4253 + "endAddress": "string", 4254 + "drivers": [ 4349 4349 { 4350 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя4351 - "driverName": "string", ~/~/ФИО водителя4352 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки4256 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4257 + "driverName": "string", 4258 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4353 4353 } 4354 4354 ] 4355 4355 } ... ... @@ -4358,6 +4358,34 @@ 4358 4358 ] 4359 4359 } 4360 4360 4267 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4268 +|from|Дата начала запроса 4269 +|to|Дата окончания 4270 +|vehicleId|ID объекта 4271 +|vehicleName|Имя объекта 4272 +|vehicleModel|Модель объекта 4273 +|penalty|Сумма штрафных баллов 4274 +|score|Оценка 4275 +|totalViolations|Суммарное количество нарушений 4276 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4277 +|overspeedingViolations|Превышение скорости 4278 +|accelerationViolations|Ускорение 4279 +|brakingViolations|Торможение 4280 +|turningViolations|Резкий поворот 4281 +|dangerousDrivingViolations|Резкое вождение 4282 +|sensorViolations|Нарушение по датчику 4283 +|moveTime|Время в движении 4284 +|mileage|Пробег (км) 4285 +|tripsCount|Количество рейсов 4286 +|motohours|Моточасы 4287 +|maxSpeed|Максимальная скорость 4288 +|startAddress|Адрес начала рейса 4289 +|endAddress|Адрес окончания рейса 4290 +|drivers|Список водителей, которые были на объекте в течениии рейса 4291 +|driverGuid|Guid водителя 4292 +|driverName|Имя водителя 4293 +|driverRfid|Номер Карты-метки 4294 + 4361 4361 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4362 4362 4363 4363 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==