Last modified by Андрей Калиновский on 2025/01/14 11:58
<
From version < 189.1 >
edited by Андрей Калиновский
on 2024/11/22 14:54
To version < 179.1 >
edited by Андрей Калиновский
on 2024/10/31 10:25
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,16 +1,5 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 -(% class="box warningmessage" %)
4 -(((
5 -(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно просим вас соблюдать несколько простых правил при использовании API-команд:##
6 -)))
7 -
8 -* Формировать не более 3 отчётов одновременно.
9 -* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
10 -
11 -В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд.
12 -
13 -
14 14  **Содержание страницы:**
15 15  )))
16 16  
... ... @@ -1568,78 +1568,6 @@
1568 1568  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1569 1569  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1570 1570  
1571 -
1572 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1573 -
1574 -(% class="box successmessage" %)
1575 -(((
1576 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1577 -)))
1578 -
1579 -Метод запроса: **POST**
1580 -
1581 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1582 -
1583 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1584 -
1585 -
1586 -Ответ:
1587 -
1588 -{
1589 -
1590 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1591 -
1592 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1593 -
1594 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1595 -
1596 - "Message": "string", ~/~/ Информация о выполнении запроса
1597 -
1598 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1599 -
1600 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1601 -
1602 - "Data": "string" ~/~/ Данные
1603 -
1604 -}
1605 -
1606 -
1607 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1608 -
1609 -(% class="box infomessage" %)
1610 -(((
1611 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1612 -)))
1613 -
1614 -Метод запроса: **GET**
1615 -
1616 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1617 -
1618 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1619 -
1620 -
1621 -Ответ:
1622 -
1623 -{
1624 -
1625 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1626 -
1627 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1628 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1629 -
1630 - "Message": "string", ~/~/ Информация о выполнении запроса
1631 -
1632 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1633 -
1634 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1635 -
1636 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1637 -
1638 - "Data": "string" ~/~/ Данные
1639 -
1640 -}
1641 -
1642 -
1643 1643  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1644 1644  
1645 1645  (% class="box infomessage" %)
... ... @@ -1681,12 +1681,9 @@
1681 1681   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1682 1682   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1683 1683   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1684 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1685 - "unitName": "string",  ~/~/ Название подразделения (опционально)
1686 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1687 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1688 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1689 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1601 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1602 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1603 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1690 1690  }
1691 1691  
1692 1692  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1693,15 +1693,8 @@
1693 1693  
1694 1694  (% style="color:#000000" %)Ответ:
1695 1695  
1696 -(% style="color:#000000" %)[
1697 -{
1698 -
1699 -(((
1700 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1701 -)))
1702 -
1703 -(((
1704 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1610 +(% style="color:#000000" %){
1611 + "vehicleId": "" ~/~/ идентификатор объекта
1705 1705   "name": "" ~/~/ наименование объекта
1706 1706   "imei": "" ~/~/ IMEI объекта
1707 1707   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1726,21 +1726,9 @@
1726 1726   "forClient": true, ~/~/ право на отображение у клиента
1727 1727   "forTooltip": false, ~/~/ право на отображение в подсказке
1728 1728   "forReport": false ~/~/ право на отображение в отчетах
1729 -)))
1636 + }(%%)
1637 +(% style="color:#000000" %)}
1730 1730  
1731 -(((
1732 - }
1733 - ],
1734 - "vehicleGroups": [  ~/~/ Группы ТС
1735 - {
1736 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1737 - "name": "string" ~/~/ Наименование группы ТС
1738 - }
1739 - ]
1740 - }
1741 -]
1742 -)))
1743 -
1744 1744  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1745 1745  
1746 1746  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -2541,7 +2541,7 @@
2541 2541   ],
2542 2542   "stops": [ ~/~/ События стоянок
2543 2543   {
2544 - "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2439 + "address": "string", ~/~/ Адрес события
2545 2545   "eventId": 0, ~/~/ Идентификатор события
2546 2546   "eventName": "string", ~/~/ Название события
2547 2547   "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
... ... @@ -4303,67 +4303,64 @@
4303 4303  Тело запроса:
4304 4304  
4305 4305  {
4306 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4307 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4308 - "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"
4309 4309  }
4310 4310  
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 +
4311 4311  Ответ:
4312 4312  
4313 4313  {
4314 - "items": [  ~/~/ Список в разрезе ТС
4214 + "items": [
4315 4315   {
4316 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4317 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4318 - "vehicleId": 0, ~/~/ ID ТС
4319 - "vehicleName": "string", ~/~/ Название ТС
4320 - "vehicleModel": "string", ~/~/ Модель ТС
4321 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4322 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4323 - "totalViolations": 0, ~/~/ Нарушений всего
4324 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4325 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4326 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4327 - "brakingViolations": 0, ~/~/ Нарушений торможения
4328 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4329 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4330 - "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
4331 4331   },
4332 -
4333 -(((
4334 -
4335 -)))
4336 -
4337 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4338 - "mileage": 0, ~/~/ Пробег, м
4339 - "tripsCount": 0, ~/~/ Кол-во рейсов
4340 - "trips": [  ~/~/ Информация по рейсу
4232 + "moveTime": 0,
4233 + "mileage": 0,
4234 + "tripsCount": 0,
4235 + "trips": [
4341 4341   {
4342 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4343 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4344 - "violationsCount": 0, ~/~/ Всего нарушений
4345 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4346 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4347 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4348 - "brakingViolations": 0, ~/~/ Нарушений торможения
4349 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4350 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4351 - "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
4352 4352   },
4353 -
4354 - "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4355 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4356 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4357 - "mileage": 0, ~/~/ Пробег, м
4358 - "motohours": 0, ~/~/ Моточасы, секунды
4359 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4360 - "startAddress": "string", ~/~/ Адрес начала рейса
4361 - "endAddress": "string", ~/~/ Адрес конца рейса
4362 - "drivers": [  ~/~/ Список водителей
4248 + "moveTime": 0,
4249 + "mileage": 0,
4250 + "motohours": 0,
4251 + "maxSpeed": 0,
4252 + "startAddress": "string",
4253 + "endAddress": "string",
4254 + "drivers": [
4363 4363   {
4364 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4365 - "driverName": "string", ~/~/ФИО водителя
4366 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4256 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4257 + "driverName": "string",
4258 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4367 4367   }
4368 4368   ]
4369 4369   }
... ... @@ -4372,6 +4372,34 @@
4372 4372   ]
4373 4373  }
4374 4374  
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 +
4375 4375  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4376 4376  
4377 4377  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

Меню

ГЛОНАССSoft wiki - 2024 г.