Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/14 11:58
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. SupportZhuchkov1 +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 -Идентификатор команды: cmd Id1199 +Идентификатор команды: 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 ~/~/ время запроса ... ... @@ -1386,19 +1386,9 @@ 1386 1386 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1387 1387 ~/~/ "ValueOn": "Вкл.", 1388 1388 ~/~/ "ValueOff": "Выкл." 1389 - "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1390 - 1391 -((( 1392 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1393 - { 1394 - "from": 0, ~/~/ С какого значения 1395 - "color": "string", ~/~/ Каким цветом 1396 - "text": "string" ~/~/ Текст подписи к этому интервалу 1397 - } 1398 - ] 1375 + "summaryMaxValue": 0 ~/~/ Макс. значение 1399 1399 } 1400 1400 ], 1401 -))) 1402 1402 1403 1403 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1404 1404 ... ... @@ -1405,12 +1405,12 @@ 1405 1405 1406 1406 "customFields": [ ~/~/ Произвольные поля 1407 1407 { 1408 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности1409 - "name": "string", ~/~/ Наименование произвольного поля1410 - "value": "string", ~/~/ Значение произвольного поля1411 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента1412 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)1413 - "forReport": true ~/~/ Отобразить произвольное поле в отчете1384 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1385 + "name": "string", 1386 + "value": "string", 1387 + "forClient": true, 1388 + "forTooltip": true, 1389 + "forReport": true 1414 1414 } 1415 1415 ] 1416 1416 } ... ... @@ -1420,7 +1420,6 @@ 1420 1420 1421 1421 ((( 1422 1422 ((( 1423 -((( 1424 1424 { 1425 1425 "vehicleId": 0, ~/~/ ID ТС 1426 1426 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС ... ... @@ -1540,10 +1540,9 @@ 1540 1540 { 1541 1541 "from": 0, ~/~/ С какого значения 1542 1542 "color": "string", ~/~/ Каким цветом 1518 + (% style="background-color:inherit; color:inherit; font-family:Menlo,Monaco,Consolas,~"Courier New~",monospace; font-size:inherit; white-space:pre" %)"text": "string" 1543 1543 ))) 1544 1544 1545 -((( 1546 - "text": "string" ~/~/ Текст подписи к этому интервалу 1547 1547 } 1548 1548 ] 1549 1549 } ... ... @@ -1562,8 +1562,6 @@ 1562 1562 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1563 1563 } 1564 1564 ))) 1565 -))) 1566 -))) 1567 1567 1568 1568 1569 1569 **Валидация:** ... ... @@ -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" ~/~/ Идентификатор агента, для которого надо получить данные 1587 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 1588 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1589 + "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": "" ~/~/ идентификатор объекта 1596 +(% style="color:#000000" %){ 1597 + "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 -))) 1622 + }(%%) 1623 +(% 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" %)**Изменение статуса объекта**(%%) == ... ... @@ -1928,31 +1928,25 @@ 1928 1928 ~/~/ "ValueOn": "Вкл.", 1929 1929 ~/~/ "ValueOff": "Выкл." 1930 1930 "summaryMaxValue": 0 ~/~/ Макс. значение 1931 - 1932 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1933 - { 1934 - "from": 0, ~/~/ С какого значения 1935 - "color": "string", ~/~/ Каким цветом 1936 - "text": "string" ~/~/ Текст подписи к этому интервалу 1937 - } 1938 - ] 1939 1939 } 1940 1940 ], 1811 + 1812 +((( 1941 1941 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1814 +))) 1942 1942 1943 1943 "customFields": [ ~/~/ Произвольные поля 1944 - { 1945 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности1946 - "name": "string", ~/~/ Наименование произвольного поля1947 - "value": "string", ~/~/ Значение произвольного поля1948 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента1949 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)1950 - "forReport": true ~/~/ Отобразить произвольное поле в отчете1817 + { 1818 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1819 + "name": "string", 1820 + "value": "string", 1821 + "forClient": true, 1822 + "forTooltip": true, 1823 + "forReport": true 1951 1951 } 1952 1952 ] 1953 1953 } 1954 1954 1955 - 1956 1956 (% style="color:#000000" %)Ответ: 1957 1957 1958 1958 ((( ... ... @@ -1992,7 +1992,7 @@ 1992 1992 "cmsv6Parameters": { ~/~/ Dto для CMSv6 1993 1993 "id": "string", ~/~/ CMSV6 Идентификатор 1994 1994 "enabled": true, ~/~/ Признак включения 1995 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1867 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1996 1996 ))) 1997 1997 1998 1998 ... ... @@ -2544,7 +2544,7 @@ 2544 2544 ], 2545 2545 "stops": [ ~/~/ События стоянок 2546 2546 { 2547 - "address": " [Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес событияУлица, Дом, Город, Регион, Страна, Координаты2419 + "address": "string", ~/~/ Адрес события 2548 2548 "eventId": 0, ~/~/ Идентификатор события 2549 2549 "eventName": "string", ~/~/ Название события 2550 2550 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события ... ... @@ -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" ~/~/ Дата окончания запроса4181 + "vehicleIds": [vehicleId], 4182 + "from": "2023-11-22T09:29:48.051Z", 4183 + "to": "2023-11-22T09:29:48.051Z" 4312 4312 } 4313 4313 4186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4187 +|vehicleIds|Массив ID объектов 4188 +|from|Дата начала запроса 4189 +|to|Дата окончания запроса 4190 + 4314 4314 Ответ: 4315 4315 4316 4316 { 4317 - "items": [ ~/~/ Список в разрезе ТС4194 + "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 ~/~/ Нарушений по датчику4196 + "from": "2023-11-22T09:29:48.052Z", 4197 + "to": "2023-11-22T09:29:48.052Z", 4198 + "vehicleId": 0, 4199 + "vehicleName": "string", 4200 + "vehicleModel": "string", 4201 + "penalty": 0, 4202 + "score": 0, 4203 + "totalViolations": 0, 4204 + "violationsByType": { 4205 + "overspeedingViolations": 0, 4206 + "accelerationViolations": 0, 4207 + "brakingViolations": 0, 4208 + "turningViolations": 0, 4209 + "dangerousDrivingViolations": 0, 4210 + "sensorViolations": 0 4334 4334 }, 4335 - 4336 -((( 4337 - 4338 -))) 4339 - 4340 - "moveTime": 0, ~/~/ Продолжительность движения, сек 4341 - "mileage": 0, ~/~/ Пробег, м 4342 - "tripsCount": 0, ~/~/ Кол-во рейсов 4343 - "trips": [ ~/~/ Информация по рейсу 4212 + "moveTime": 0, 4213 + "mileage": 0, 4214 + "tripsCount": 0, 4215 + "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 ~/~/ Нарушений по датчику4217 + "penalty": 0, 4218 + "score": 0, 4219 + "violationsCount": 0, 4220 + "violationsByType": { 4221 + "overspeedingViolations": 0, 4222 + "accelerationViolations": 0, 4223 + "brakingViolations": 0, 4224 + "turningViolations": 0, 4225 + "dangerousDrivingViolations": 0, 4226 + "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": [ ~/~/ Список водителей 4228 + "moveTime": 0, 4229 + "mileage": 0, 4230 + "motohours": 0, 4231 + "maxSpeed": 0, 4232 + "startAddress": "string", 4233 + "endAddress": "string", 4234 + "drivers": [ 4366 4366 { 4367 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя4368 - "driverName": "string", ~/~/ФИО водителя4369 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки4236 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4237 + "driverName": "string", 4238 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4370 4370 } 4371 4371 ] 4372 4372 } ... ... @@ -4375,6 +4375,34 @@ 4375 4375 ] 4376 4376 } 4377 4377 4247 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4248 +|from|Дата начала запроса 4249 +|to|Дата окончания 4250 +|vehicleId|ID объекта 4251 +|vehicleName|Имя объекта 4252 +|vehicleModel|Модель объекта 4253 +|penalty|Сумма штрафных баллов 4254 +|score|Оценка 4255 +|totalViolations|Суммарное количество нарушений 4256 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4257 +|overspeedingViolations|Превышение скорости 4258 +|accelerationViolations|Ускорение 4259 +|brakingViolations|Торможение 4260 +|turningViolations|Резкий поворот 4261 +|dangerousDrivingViolations|Резкое вождение 4262 +|sensorViolations|Нарушение по датчику 4263 +|moveTime|Время в движении 4264 +|mileage|Пробег (км) 4265 +|tripsCount|Количество рейсов 4266 +|motohours|Моточасы 4267 +|maxSpeed|Максимальная скорость 4268 +|startAddress|Адрес начала рейса 4269 +|endAddress|Адрес окончания рейса 4270 +|drivers|Список водителей, которые были на объекте в течениии рейса 4271 +|driverGuid|Guid водителя 4272 +|driverName|Имя водителя 4273 +|driverRfid|Номер Карты-метки 4274 + 4378 4378 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4379 4379 4380 4380 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==