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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.SupportZhuchkov
Content
... ... @@ -1,9 +1,23 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 -**Содержание страницы:**\
3 +(% class="box warningmessage" %)
4 +(((
5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 +просим вас соблюдать несколько простых правил при использовании API-команд:##
4 4  )))
5 5  
9 +* Формировать не более 3 отчётов одновременно.
10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
6 6  
12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд.
13 +
14 +
15 +**Содержание страницы:**
16 +)))
17 +
18 +{{toc/}}
19 +
20 +
7 7  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 8  
9 9  (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
... ... @@ -1170,41 +1170,6 @@
1170 1170  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1171 1171  
1172 1172  
1173 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1174 -
1175 -(% class="box successmessage" %)
1176 -(((
1177 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1178 -)))
1179 -
1180 -(% style="color:#000000" %)Метод запроса: **POST**
1181 -
1182 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId}
1183 -
1184 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства
1185 -
1186 -
1187 -Ответ:
1188 -
1189 -{
1190 -
1191 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1192 -
1193 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1194 -
1195 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1196 -
1197 - "Message": "string", ~/~/ Информация о выполнении запроса
1198 -
1199 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1200 -
1201 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1202 -
1203 - "Data": "string" ~/~/ Данные
1204 -
1205 -}
1206 -
1207 -
1208 1208  == **Отправить команду на терминал** ==
1209 1209  
1210 1210  (% class="box successmessage" %)
... ... @@ -1215,13 +1215,15 @@
1215 1215  Команда для отправки на тс.
1216 1216  
1217 1217  {  
1218 -"id": "", ~/~/идентификатор произвольного поля
1219 -"command": "", ~/~/ Текст команды
1220 -"retries": "", ~/~/ Количество попыток
1221 -"idTemplate": "" ~/~/ ID шаблона команды
1197 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1198 +"command": "", ~/~/ Текст отправляемой команды
1199 +"retries": "", ~/~/ Количество попыток отправки на терминал
1200 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1222 1222  }
1223 1223  
1203 +В ответ получаем cmdid
1224 1224  
1205 +
1225 1225  == **Получить ответ на отправленную на ТС команду** ==
1226 1226  
1227 1227  (% class="box infomessage" %)
... ... @@ -1229,13 +1229,13 @@
1229 1229  (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1230 1230  )))
1231 1231  
1232 -Идентификатор команды: cmdid
1213 +Идентификатор команды: cmdId
1233 1233  
1234 1234  Запрос от терминала на ответ команды
1235 1235  
1236 1236  Пример ответ от терминала:
1237 1237  
1238 -ID= "" ~/~/ идентификатор произвольного поля
1219 +ID= "" ~/~/ идентификатор объекта
1239 1239  Soft="" ~/~/ версия софта
1240 1240  GPS=4 ~/~/ тип трекера
1241 1241  Time=11:05:43 28.06.24 ~/~/ время запроса
... ... @@ -1590,6 +1590,78 @@
1590 1590  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1591 1591  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1592 1592  
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 +
1593 1593  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1594 1594  
1595 1595  (% class="box infomessage" %)

Меню

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