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. Gadmin1 +XWiki.SupportZhuchkov - 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 ... ... @@ -1182,13 +1182,15 @@ 1182 1182 Команда для отправки на тс. 1183 1183 1184 1184 { 1185 -"id": "", ~/~/идентификатор произвольногополя1186 -"command": "", ~/~/ Текст команды 1187 -"retries": "", ~/~/ Количество попыток 1188 -"idTemplate": "" ~/~/ ID шаблона команды 1197 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1198 +"command": "", ~/~/ Текст отправляемой команды 1199 +"retries": "", ~/~/ Количество попыток отправки на терминал 1200 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1189 1189 } 1190 1190 1203 +В ответ получаем cmdid 1191 1191 1205 + 1192 1192 == **Получить ответ на отправленную на ТС команду** == 1193 1193 1194 1194 (% class="box infomessage" %) ... ... @@ -1196,13 +1196,13 @@ 1196 1196 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1197 1197 ))) 1198 1198 1199 -Идентификатор команды: cmd id1213 +Идентификатор команды: cmdId 1200 1200 1201 1201 Запрос от терминала на ответ команды 1202 1202 1203 1203 Пример ответ от терминала: 1204 1204 1205 -ID= "" ~/~/ идентификатор произвольного поля1219 +ID= "" ~/~/ идентификатор объекта 1206 1206 Soft="" ~/~/ версия софта 1207 1207 GPS=4 ~/~/ тип трекера 1208 1208 Time=11:05:43 28.06.24 ~/~/ время запроса ... ... @@ -1557,6 +1557,78 @@ 1557 1557 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1558 1558 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1559 1559 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 + 1560 1560 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1561 1561 1562 1562 (% class="box infomessage" %)