Changes for page Методы API для работы с ГЛОНАССSoft

Last modified by Андрей Калиновский on 2025/01/14 11:58

From version < 184.1 >

edited by Андрей Калиновский
on 2024/11/22 13:26

To version < 192.1 >

edited by Михаил Жучков
on 2024/12/16 18:00

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.Gadmin
++XWiki.SupportZhuchkov

Content

@@ -1,9 +1,23 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
  (((
--**Содержание страницы:**\
++(% class="box warningmessage" %)
++(((
++(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
++просим вас соблюдать несколько простых правил при использовании API-команд:##
  )))
++* Формировать не более 3 отчётов одновременно.
++* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
++В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
++
++
++**Содержание страницы:**
++)))
++
++{{toc/}}
++
++
  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
  (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
@@ -1170,77 +1170,6 @@
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--== **Импортировать историю ТС (Асинхронный запрос)** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)**https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
--
--(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
--
--~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
--== **Возвращает статус асинхронного запроса импорта истории ТС** ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
--)))
--
--(% style="color:#000000" %)Метод запроса: **GET**
--
--(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
--
--(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполения запроса
--~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
--
--~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
  == **Отправить команду на терминал** ==
  (% class="box successmessage" %)
@@ -1251,13 +1251,15 @@
  Команда для отправки на тс.
  {
--"id": "",  ~/~/идентификатор произвольного поля
--"command": "", ~/~/  Текст команды
--"retries": "",  ~/~/ Количество попыток
--"idTemplate": "" ~/~/ ID шаблона команды
++"id": "",  ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
++"command": "", ~/~/  Текст отправляемой команды
++"retries": "",  ~/~/ Количество попыток отправки на терминал
++"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов).
  }
++В ответ получаем cmdid
++
  == **Получить ответ на отправленную на ТС команду** ==
  (% class="box infomessage" %)
@@ -1265,13 +1265,13 @@
  (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
  )))
--Идентификатор команды: cmdid
++Идентификатор команды: cmdId
  Запрос от терминала на ответ команды
  Пример ответ от терминала:
--ID= "" ~/~/ идентификатор произвольного поля
++ID= "" ~/~/ идентификатор объекта
  Soft="" ~/~/ версия софта
  GPS=4 ~/~/ тип трекера
  Time=11:05:43 28.06.24 ~/~/ время запроса
@@ -1626,6 +1626,78 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
++
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
++)))
++
++Метод запроса: **POST**
++
++URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
++
++Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
++
++~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
++== **Возвращает статус асинхронного запроса импорта истории ТС** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
++)))
++
++Метод запроса: **GET**
++
++URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
++
++Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполения запроса
++~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
++
++~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
  (% class="box infomessage" %)
@@ -4421,22 +4421,22 @@
  Пример ответа:
  {
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [    ~/~/ Объекты для ретрансляции
  {
  "id": "",  ~/~/ Идентификатор объекта ретрансляции
  "name": "",   ~/~/ Наименование объекта ретрансляции
--"imei": "",     ~/~/ IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"imei": "",     ~/~/ IMEI объекта  ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
    ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/Guid родителя
--"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
  }
@@ -4447,7 +4447,7 @@
  **DELETE** **/api/v3/retranslations/{id}**
  )))
--Параметр запроса: ID
++Параметр запроса: ID - Идентификатор ретранслятора
  == **Создание ретранслятора** ==
@@ -4460,16 +4460,16 @@
  Запрос:
  {
--"description": "",  ~/~/ Описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"address": "",  ~/~/ Адрес ретрансляции
--"isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"address": "",  ~/~/ Адрес и порт принимающего сервера
++"isEnabled": "",  ~/~/ Признак включения ретранслятора, true - включен, false - отключен
  "objects": [    ~/~/Объекты для ретрансляции
  {
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",     ~/~/IMEI объекта
--"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",  ~/~/ Идентификатор ретранслятора
++"imei": "",     ~/~/ IMEI объекта ретрансляции
++"isEnabled":  ""  ~/~/ Признак включения объекта  ретрансляции: true - включен, false - отключен
  }
    ]
  }
@@ -4478,22 +4478,22 @@
  Ответ:
  {
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,   ~/~/ Тип протокола
--"isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [     ~/~/ Объекты для ретрансляции
  {
--"id": "",     ~/~/ идентификатор пользователя
--"name": "string",     ~/~/ Название уведомления
--"imei": "string",    ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",    ~/~/ Идентификатор объекта ретрансляции
++"name": "string",  ~/~/ Наименование объекта ретрансляции
++"imei": "",      ~/~/ IMEI объекта ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
++  ],
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
  }
@@ -4507,18 +4507,18 @@
  Пример запроса:
  {
--"id": "",  ~/~/ идентификатор пользователя
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",   ~/~/ Адрес события
--"objects":  ~/~/Объекты для ретрансляции
++"id": "",  ~/~/ Идентификатор ретранслятора
++"description": "string",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",   ~/~/ Адрес и порт принимающего сервера
++"objects":  ~/~/ Объекты для ретрансляции
  [
  {
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",       ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++"imei": "",       ~/~/ IMEI объекта  ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
    ]
  }
@@ -4527,22 +4527,22 @@
  Пример ответа:
  {
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [     ~/~/Объекты для ретрансляции
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [     ~/~/ Объекты для ретрансляции
  {
--"id": "",    ~/~/ идентификатор пользователя
--"name": "string",  ~/~/ Название уведомления
--"imei": "",      ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++"id": "",    ~/~/ Идентификатор объекта ретрансляции
++"name": "string",  ~/~/ Наименование объекта ретрансляции
++"imei": "",      ~/~/ IMEI объекта ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
  }
    ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
  }
@@ -4556,9 +4556,9 @@
  Пример запроса:
  {
--"id": "",  ~/~/ идентификатор пользователя
++"id": "",  ~/~/ Идентификатор ретранслятора
  "search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
--"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
++"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (вышестоящего клиента).
  }
  Ответ:
@@ -4565,14 +4565,14 @@
  [
  {
--"description": "",    ~/~/ Определяет описание
--"subscriberId": "",    ~/~/ идентификатор запроса
--"protocolType": 0,     ~/~/ Тип протокола
--"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",    ~/~/ Адрес события
--"id": "",    ~/~/ идентификатор пользователя
--"parentId": "",    ~/~/ Guid идентификатор родителя
--"deleted": true   ~/~/ Признак удаления
++"description": "",    ~/~/ Поле описания ретранслятора
++"subscriberId": "",    ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,     ~/~/ Тип протокола ретрансляции
++"isEnabled": true,    ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",    ~/~/ Адрес и порт принимающего сервера
++"id": "",    ~/~/ Идентификатор ретранслятора
++"parentId": "",    ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true   ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
  }
  ]

Changes for page Методы API для работы с ГЛОНАССSoft

Summary

Details

Меню