Last modified by Андрей Калиновский on 2025/01/14 11:58
<
From version < 191.1 >
edited by Михаил Жучков
on 2024/12/09 16:25
To version < 180.1 >
edited by Андрей Калиновский
on 2024/11/14 16:13
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
1 +XWiki.Gadmin
Content
... ... @@ -1,17 +1,5 @@
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 -
15 15  **Содержание страницы:**
16 16  )))
17 17  
... ... @@ -1194,15 +1194,13 @@
1194 1194  Команда для отправки на тс.
1195 1195  
1196 1196  {  
1197 -"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1198 -"command": "", ~/~/ Текст отправляемой команды
1199 -"retries": "", ~/~/ Количество попыток отправки на терминал
1200 -"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1185 +"id": "", ~/~/идентификатор произвольного поля
1186 +"command": "", ~/~/ Текст команды
1187 +"retries": "", ~/~/ Количество попыток
1188 +"idTemplate": "" ~/~/ ID шаблона команды
1201 1201  }
1202 1202  
1203 -В ответ получаем cmdid
1204 1204  
1205 -
1206 1206  == **Получить ответ на отправленную на ТС команду** ==
1207 1207  
1208 1208  (% class="box infomessage" %)
... ... @@ -1210,13 +1210,13 @@
1210 1210  (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1211 1211  )))
1212 1212  
1213 -Идентификатор команды: cmdId
1199 +Идентификатор команды: cmdid
1214 1214  
1215 1215  Запрос от терминала на ответ команды
1216 1216  
1217 1217  Пример ответ от терминала:
1218 1218  
1219 -ID= "" ~/~/ идентификатор объекта
1205 +ID= "" ~/~/ идентификатор произвольного поля
1220 1220  Soft="" ~/~/ версия софта
1221 1221  GPS=4 ~/~/ тип трекера
1222 1222  Time=11:05:43 28.06.24 ~/~/ время запроса
... ... @@ -1571,78 +1571,6 @@
1571 1571  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1572 1572  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1573 1573  
1574 -
1575 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1576 -
1577 -(% class="box successmessage" %)
1578 -(((
1579 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1580 -)))
1581 -
1582 -Метод запроса: **POST**
1583 -
1584 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1585 -
1586 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1587 -
1588 -
1589 -Ответ:
1590 -
1591 -{
1592 -
1593 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1594 -
1595 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1596 -
1597 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1598 -
1599 - "Message": "string", ~/~/ Информация о выполнении запроса
1600 -
1601 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1602 -
1603 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1604 -
1605 - "Data": "string" ~/~/ Данные
1606 -
1607 -}
1608 -
1609 -
1610 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1611 -
1612 -(% class="box infomessage" %)
1613 -(((
1614 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1615 -)))
1616 -
1617 -Метод запроса: **GET**
1618 -
1619 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1620 -
1621 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1622 -
1623 -
1624 -Ответ:
1625 -
1626 -{
1627 -
1628 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1629 -
1630 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1631 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1632 -
1633 - "Message": "string", ~/~/ Информация о выполнении запроса
1634 -
1635 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1636 -
1637 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1638 -
1639 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1640 -
1641 - "Data": "string" ~/~/ Данные
1642 -
1643 -}
1644 -
1645 -
1646 1646  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1647 1647  
1648 1648  (% class="box infomessage" %)
... ... @@ -1684,12 +1684,9 @@
1684 1684   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1685 1685   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1686 1686   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1687 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1688 - "unitName": "string",  ~/~/ Название подразделения (опционально)
1689 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1690 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1691 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1692 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1601 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1602 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1603 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1693 1693  }
1694 1694  
1695 1695  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1696,15 +1696,8 @@
1696 1696  
1697 1697  (% style="color:#000000" %)Ответ:
1698 1698  
1699 -(% style="color:#000000" %)[
1700 -{
1701 -
1702 -(((
1703 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1704 -)))
1705 -
1706 -(((
1707 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1610 +(% style="color:#000000" %){
1611 + "vehicleId": "" ~/~/ идентификатор объекта
1708 1708   "name": "" ~/~/ наименование объекта
1709 1709   "imei": "" ~/~/ IMEI объекта
1710 1710   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1729,21 +1729,9 @@
1729 1729   "forClient": true, ~/~/ право на отображение у клиента
1730 1730   "forTooltip": false, ~/~/ право на отображение в подсказке
1731 1731   "forReport": false ~/~/ право на отображение в отчетах
1732 -)))
1636 + }(%%)
1637 +(% style="color:#000000" %)}
1733 1733  
1734 -(((
1735 - }
1736 - ],
1737 - "vehicleGroups": [  ~/~/ Группы ТС
1738 - {
1739 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1740 - "name": "string" ~/~/ Наименование группы ТС
1741 - }
1742 - ]
1743 - }
1744 -]
1745 -)))
1746 -
1747 1747  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1748 1748  
1749 1749  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -4306,67 +4306,64 @@
4306 4306  Тело запроса:
4307 4307  
4308 4308  {
4309 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4310 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4311 - "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"
4312 4312  }
4313 4313  
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 +
4314 4314  Ответ:
4315 4315  
4316 4316  {
4317 - "items": [  ~/~/ Список в разрезе ТС
4214 + "items": [
4318 4318   {
4319 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4320 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4321 - "vehicleId": 0, ~/~/ ID ТС
4322 - "vehicleName": "string", ~/~/ Название ТС
4323 - "vehicleModel": "string", ~/~/ Модель ТС
4324 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4325 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4326 - "totalViolations": 0, ~/~/ Нарушений всего
4327 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4328 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4329 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4330 - "brakingViolations": 0, ~/~/ Нарушений торможения
4331 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4332 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4333 - "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
4334 4334   },
4335 -
4336 -(((
4337 -
4338 -)))
4339 -
4340 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4341 - "mileage": 0, ~/~/ Пробег, м
4342 - "tripsCount": 0, ~/~/ Кол-во рейсов
4343 - "trips": [  ~/~/ Информация по рейсу
4232 + "moveTime": 0,
4233 + "mileage": 0,
4234 + "tripsCount": 0,
4235 + "trips": [
4344 4344   {
4345 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4346 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4347 - "violationsCount": 0, ~/~/ Всего нарушений
4348 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4349 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4350 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4351 - "brakingViolations": 0, ~/~/ Нарушений торможения
4352 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4353 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4354 - "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
4355 4355   },
4356 -
4357 - "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4358 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4359 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4360 - "mileage": 0, ~/~/ Пробег, м
4361 - "motohours": 0, ~/~/ Моточасы, секунды
4362 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4363 - "startAddress": "string", ~/~/ Адрес начала рейса
4364 - "endAddress": "string", ~/~/ Адрес конца рейса
4365 - "drivers": [  ~/~/ Список водителей
4248 + "moveTime": 0,
4249 + "mileage": 0,
4250 + "motohours": 0,
4251 + "maxSpeed": 0,
4252 + "startAddress": "string",
4253 + "endAddress": "string",
4254 + "drivers": [
4366 4366   {
4367 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4368 - "driverName": "string", ~/~/ФИО водителя
4369 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4256 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4257 + "driverName": "string",
4258 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4370 4370   }
4371 4371   ]
4372 4372   }
... ... @@ -4375,6 +4375,34 @@
4375 4375   ]
4376 4376  }
4377 4377  
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 +
4378 4378  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4379 4379  
4380 4380  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

Меню

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