Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/14 11:58
<
>
edited by Андрей Калиновский
on 2024/11/18 16:39
on 2024/11/18 16:39
edited by Андрей Калиновский
on 2024/11/22 13:26
on 2024/11/22 13:26
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,11 +1,9 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 -**Содержание страницы:** 3 +**Содержание страницы:**\ 4 4 ))) 5 5 6 -{{toc/}} 7 7 8 - 9 9 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 10 11 11 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). ... ... @@ -1172,6 +1172,77 @@ 1172 1172 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1173 1173 1174 1174 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 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1209 + 1210 +(% class="box infomessage" %) 1211 +((( 1212 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1213 +))) 1214 + 1215 +(% style="color:#000000" %)Метод запроса: **GET** 1216 + 1217 +(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1218 + 1219 +(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса 1220 + 1221 + 1222 +Ответ: 1223 + 1224 +{ 1225 + 1226 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1227 + 1228 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1229 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1230 + 1231 + "Message": "string", ~/~/ Информация о выполнении запроса 1232 + 1233 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1234 + 1235 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1236 + 1237 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1238 + 1239 + "Data": "string" ~/~/ Данные 1240 + 1241 +} 1242 + 1243 + 1175 1175 == **Отправить команду на терминал** == 1176 1176 1177 1177 (% class="box successmessage" %) ... ... @@ -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 ~/~/ значение любого из произвольных полей ТС 1670 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1671 + "unitName": "string", ~/~/ Название подразделения (опционально) 1672 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1673 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1674 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1675 + "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": "" ~/~/ идентификатор объекта 1682 +(% style="color:#000000" %)[ 1683 +{ 1684 + 1685 +((( 1686 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1687 +))) 1688 + 1689 +((( 1690 +(% 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" %)} 1715 +))) 1638 1638 1717 +((( 1718 + } 1719 + ], 1720 + "vehicleGroups": [ ~/~/ Группы ТС 1721 + { 1722 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1723 + "name": "string" ~/~/ Наименование группы ТС 1724 + } 1725 + ] 1726 + } 1727 +] 1728 +))) 1729 + 1639 1639 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1640 1640 1641 1641 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==