Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/14 11:58
<
>
edited by Андрей Калиновский
on 2024/11/22 14:38
on 2024/11/22 14:38
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
-
... ... @@ -1557,78 +1557,6 @@ 1557 1557 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1558 1558 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1559 1559 1560 - 1561 -== **Импортировать историю ТС (Асинхронный запрос)** == 1562 - 1563 -(% class="box successmessage" %) 1564 -((( 1565 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1566 -))) 1567 - 1568 -Метод запроса: **POST** 1569 - 1570 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1571 - 1572 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1573 - 1574 - 1575 -Ответ: 1576 - 1577 -{ 1578 - 1579 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1580 - 1581 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1582 - 1583 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1584 - 1585 - "Message": "string", ~/~/ Информация о выполнении запроса 1586 - 1587 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1588 - 1589 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1590 - 1591 - "Data": "string" ~/~/ Данные 1592 - 1593 -} 1594 - 1595 - 1596 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1597 - 1598 -(% class="box infomessage" %) 1599 -((( 1600 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1601 -))) 1602 - 1603 -Метод запроса: **GET** 1604 - 1605 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1606 - 1607 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1608 - 1609 - 1610 -Ответ: 1611 - 1612 -{ 1613 - 1614 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1615 - 1616 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1617 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1618 - 1619 - "Message": "string", ~/~/ Информация о выполнении запроса 1620 - 1621 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1622 - 1623 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1624 - 1625 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1626 - 1627 - "Data": "string" ~/~/ Данные 1628 - 1629 -} 1630 - 1631 - 1632 1632 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1633 1633 1634 1634 (% class="box infomessage" %) ... ... @@ -1670,12 +1670,9 @@ 1670 1670 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1671 1671 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1672 1672 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1673 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1674 - "unitName": "string", ~/~/ Название подразделения (опционально) 1675 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1676 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1677 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1678 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1601 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 1602 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1603 + "customFields": null ~/~/ значение любого из произвольных полей ТС 1679 1679 } 1680 1680 1681 1681 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1682,15 +1682,8 @@ 1682 1682 1683 1683 (% style="color:#000000" %)Ответ: 1684 1684 1685 -(% style="color:#000000" %)[ 1686 -{ 1687 - 1688 -((( 1689 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1690 -))) 1691 - 1692 -((( 1693 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1610 +(% style="color:#000000" %){ 1611 + "vehicleId": "" ~/~/ идентификатор объекта 1694 1694 "name": "" ~/~/ наименование объекта 1695 1695 "imei": "" ~/~/ IMEI объекта 1696 1696 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1715,21 +1715,9 @@ 1715 1715 "forClient": true, ~/~/ право на отображение у клиента 1716 1716 "forTooltip": false, ~/~/ право на отображение в подсказке 1717 1717 "forReport": false ~/~/ право на отображение в отчетах 1718 -))) 1636 + }(%%) 1637 +(% style="color:#000000" %)} 1719 1719 1720 -((( 1721 - } 1722 - ], 1723 - "vehicleGroups": [ ~/~/ Группы ТС 1724 - { 1725 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1726 - "name": "string" ~/~/ Наименование группы ТС 1727 - } 1728 - ] 1729 - } 1730 -] 1731 -))) 1732 - 1733 1733 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1734 1734 1735 1735 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -4292,67 +4292,64 @@ 4292 4292 Тело запроса: 4293 4293 4294 4294 { 4295 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов4296 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса4297 - "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" 4298 4298 } 4299 4299 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 + 4300 4300 Ответ: 4301 4301 4302 4302 { 4303 - "items": [ ~/~/ Список в разрезе ТС4214 + "items": [ 4304 4304 { 4305 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода4306 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода4307 - "vehicleId": 0, ~/~/ ID ТС4308 - "vehicleName": "string", ~/~/ Название ТС4309 - "vehicleModel": "string", ~/~/ Модель ТС4310 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС4311 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС4312 - "totalViolations": 0, ~/~/ Нарушений всего4313 - "violationsByType": { ~/~/ Информация о нарушениях по типу4314 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости4315 - "accelerationViolations": 0, ~/~/ Нарушений ускорения4316 - "brakingViolations": 0, ~/~/ Нарушений торможения4317 - "turningViolations": 0, ~/~/ Нарушений опасного поворота4318 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения4319 - "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 4320 4320 }, 4321 - 4322 -((( 4323 - 4324 -))) 4325 - 4326 - "moveTime": 0, ~/~/ Продолжительность движения, сек 4327 - "mileage": 0, ~/~/ Пробег, м 4328 - "tripsCount": 0, ~/~/ Кол-во рейсов 4329 - "trips": [ ~/~/ Информация по рейсу 4232 + "moveTime": 0, 4233 + "mileage": 0, 4234 + "tripsCount": 0, 4235 + "trips": [ 4330 4330 { 4331 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс4332 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс4333 - "violationsCount": 0, ~/~/ Всего нарушений4334 - "violationsByType": { ~/~/ Информация о нарушениях по типу4335 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости4336 - "accelerationViolations": 0, ~/~/ Нарушений ускорения4337 - "brakingViolations": 0, ~/~/ Нарушений торможения4338 - "turningViolations": 0, ~/~/ Нарушений опасного поворота4339 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения4340 - "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 4341 4341 }, 4342 - 4343 - "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4344 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4345 - "moveTime": 0, ~/~/ Продолжительность движения, сек 4346 - "mileage": 0, ~/~/ Пробег, м 4347 - "motohours": 0, ~/~/ Моточасы, секунды 4348 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4349 - "startAddress": "string", ~/~/ Адрес начала рейса 4350 - "endAddress": "string", ~/~/ Адрес конца рейса 4351 - "drivers": [ ~/~/ Список водителей 4248 + "moveTime": 0, 4249 + "mileage": 0, 4250 + "motohours": 0, 4251 + "maxSpeed": 0, 4252 + "startAddress": "string", 4253 + "endAddress": "string", 4254 + "drivers": [ 4352 4352 { 4353 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя4354 - "driverName": "string", ~/~/ФИО водителя4355 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки4256 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4257 + "driverName": "string", 4258 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4356 4356 } 4357 4357 ] 4358 4358 } ... ... @@ -4361,6 +4361,34 @@ 4361 4361 ] 4362 4362 } 4363 4363 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 + 4364 4364 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4365 4365 4366 4366 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==