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

Summary

Details

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

Меню

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