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

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

From version < 188.1 >

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

To version < 192.2 >

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

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,5 +1,17 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
  (((
++(% class="box warningmessage" %)
++(((
++(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
++просим вас соблюдать несколько простых правил при использовании API-команд:##
++)))
++
++* Формировать не более 3 отчётов одновременно.
++* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
++
++В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
++
++
  **Содержание страницы:**
  )))
@@ -1182,13 +1182,15 @@
  Команда для отправки на тс.
  {
--"id": "",  ~/~/идентификатор произвольного поля
--"command": "", ~/~/  Текст команды
--"retries": "",  ~/~/ Количество попыток
--"idTemplate": "" ~/~/ ID шаблона команды
++"id": "",  ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
++"command": "", ~/~/  Текст отправляемой команды
++"retries": "",  ~/~/ Количество попыток отправки на терминал
++"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов).
  }
++В ответ получаем cmdid
++
  == **Получить ответ на отправленную на ТС команду** ==
  (% class="box infomessage" %)
@@ -1196,13 +1196,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 ~/~/ время запроса
@@ -4380,31 +4380,31 @@
  Параметры в теле запроса (JSON):
  {
--  "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
--  "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
++  "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
++  "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
    "ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
    ],
--  "timezone": 0 ~/~/Таймзона
++  "timezone": 0 ~/~/ Часовой пояс
  }
  Ответ:
    {
--    "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
--    "driver": "string", ~/~/Водители, привязанные к ТК
--    "object": "string", ~/~/Наименование ТС
--    "amount": 0, ~/~/Количество топлива
--    "amountDut": 0, ~/~/Количество по ДУТ
--    "amountDiff": 0, ~/~/Разница, л
--    "amountDiffPerc": 0, ~/~/Разница, %
--    "summa": 0, ~/~/Стоимость, руб
--    "serviceName": "string", ~/~/Тип топлива
--    "price": 0, ~/~/Цена за литр, руб
--    "cardName": "string", ~/~/Наименование ТК
--    "cardNum": "string", ~/~/Номер ТК
--    "operator": "string", ~/~/Оператор ТК
--    "address": "string" ~/~/Адрес АЗС
++    "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
++    "driver": "string", ~/~/ Водители, привязанные к ТК
++    "object": "string", ~/~/ Наименование ТС
++    "amount": 0, ~/~/ Количество топлива
++    "amountDut": 0, ~/~/ Количество по ДУТ
++    "amountDiff": 0, ~/~/ Разница, л
++    "amountDiffPerc": 0, ~/~/ Разница, %
++    "summa": 0, ~/~/ Стоимость, руб
++    "serviceName": "string", ~/~/ Тип топлива
++    "price": 0, ~/~/ Цена за литр, руб
++    "cardName": "string", ~/~/ Наименование ТК
++    "cardNum": "string", ~/~/ Номер ТК
++    "operator": "string", ~/~/ Оператор ТК
++    "address": "string" ~/~/ Адрес АЗС
    }
@@ -4418,28 +4418,28 @@
  **GET ** **/api/v3/retranslations/{id}**
  )))
--Идентификатор запроса: ID
++id - Идентификатор ретранслятора
  Пример ответа:
  {
--"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 - отключен
  }
@@ -4450,7 +4450,7 @@
  **DELETE** **/api/v3/retranslations/{id}**
  )))
--Параметр запроса: ID
++id - Идентификатор ретранслятора
  == **Создание ретранслятора** ==
@@ -4463,16 +4463,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 - отключен
  }
    ]
  }
@@ -4481,22 +4481,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 - не удален
  }
@@ -4510,18 +4510,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 - отключен
  }
    ]
  }
@@ -4530,22 +4530,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 - не удален
  }
@@ -4559,9 +4559,9 @@
  Пример запроса:
  {
--"id": "",  ~/~/ идентификатор пользователя
--"search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
--"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
++"id": "",  ~/~/ Идентификатор ретранслятора
++"search": "string",  ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
++"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (вышестоящего клиента).
  }
  Ответ:
@@ -4568,14 +4568,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

Меню