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

Last modified by Андрей Калиновский on 2025/01/28 12:59

From version < 147.1 >

edited by Андрей Калиновский
on 2024/03/18 11:01

To version < 156.1 >

edited by Андрей Калиновский
on 2024/07/19 14:24

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -60,6 +60,9 @@
  |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
  |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
++(% class="wikigeneratedid" %)
++Также  имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] /  [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации -  {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
++
  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
  (% class="box infomessage" %)
@@ -1206,6 +1206,84 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
++=====   =====
++
++== **Получить ответ на отправленную на ТС команду** ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
++)))
++
++Идентификатор команды: cmdid
++
++
++Запрос от терминала на ответ команды
++
++
++Пример ответ от терминала:
++
++
++ID= "" ~/~/ идентификатор произвольного поля
++
++Soft="" ~/~/ версия софта
++
++GPS=4 ~/~/ тип трекера
++
++Time=11:05:43 28.06.24 ~/~/ время запроса
++
++Lat=45.056221 ~/~/ широта
++
++Lon=39.035938 ~/~/ долгота
++
++Speed=0.0 ~/~/ скорость
++
++Course=181.4 ~/~/направление
++
++
++
++(((
++== **Список отправленных объекту команд с ответами** ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
++)))
++
++Идентификатор ТС: vehicleId
++
++
++В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
++
++
++Пример ответа терминала
++
++
++[
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"commandText": "",   ~/~/Текст команды.
++
++"templateId": "",    ~/~/Идентификатор шаблона
++
++"updated": "",  ~/~/ Время отправки
++
++"tryCount": 0,  ~/~/ Количество попыток отправки команды
++
++"answer": "",    ~/~/ Ответ терминала.
++
++"status": "" ~/~/ Статус отправки
++
++}
++
++]
++
++
++)))
++
  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
  (% class="box successmessage" %)
@@ -1428,7 +1428,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
++(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
@@ -1549,6 +1549,30 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)  }
++(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
++**Отправить команду на терминал**
++
++(% class="box successmessage" %)
++(((
++(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
++)))
++
++Команда для отправки на тс.
++
++
++{
++
++"id": "",  ~/~/идентификатор произвольного поля
++
++"command": "", ~/~/  Текст команды
++
++"retries": "",  ~/~/ Количество попыток
++
++"idTemplate": "" ~/~/ ID шаблона команды
++
++}
++
++
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
  (% class="box warningmessage" %)
@@ -4049,68 +4049,687 @@
  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
--Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
++Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
  (% class="box infomessage" %)
  (((
--**POST**/api/v3/fuelcards/transactions
++POST /api/v3/fuelcards/transactions
  )))
--Запрос должен содержать параметры:
++Метод запроса: POST
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
++\\В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
  {
--  "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
++  "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
--  "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
++  "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
    "ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
    ],
--  "timezone": 0, ~/~/ Часовой пояс
++  "timezone": 0 ~/~/Таймзона
--  "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
++}
++Ответ:
++
++  {
++
++    "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" ~/~/Адрес АЗС
++
++  }
++
++
++==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ====
++
++
++==== **Получение полных данных о ретрансляторе** ====
++
++(% class="box infomessage" %)
++(((
++**GET ** **/api/v3/retranslations/{id}**
++)))
++
++Идентификатор запроса: ID
++
++
++Пример ответа:
++
++{
++
++"description": "",  ~/~/ Определяет описание
++
++"subscriberId": "",  ~/~/ Подписчик
++
++"protocolType": 0,  ~/~/ Тип протокола
++
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"address": "string",  ~/~/ Адрес события
++
++"objects": [    ~/~/Объекты для ретрансляции
++
++{
++
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++
++"name": "",   ~/~/ Наименование объекта ретрансляции
++
++"imei": "",     ~/~/ IMEI объекта
++
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
  }
++  ],
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"parentId": "",  ~/~/Guid родителя
++
++"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
++
++}
++
++
++==== **Удаление данных ретранслятора** ====
++
++(% class="box infomessage" %)
++(((
++**DELETE** **/api/v3/retranslations/{id}**
++)))
++
++Параметр запроса: ID
++
++
++==== **Создание ретранслятора** ====
++
++(% class="box infomessage" %)
++(((
++**POST ** **/api/v3/retranslations/{id}**
++)))
++
++Запрос:
++
++
++{
++
++"description": "",  ~/~/ Описание
++
++"subscriberId": "",  ~/~/ Подписчик
++
++"protocolType": 0,  ~/~/ Тип протокола
++
++"address": "",  ~/~/ Адрес ретрансляции
++
++"isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"objects": [    ~/~/Объекты для ретрансляции
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"imei": "",     ~/~/IMEI объекта
++
++"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++}
++
++  ]
++
++}
++
++
++
++Ответ
++
++{
++
++"description": "string",  ~/~/ Определяет описание
++
++"subscriberId": "",  ~/~/ идентификатор запроса
++
++"protocolType": 0,   ~/~/ Тип протокола
++
++"isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"address": "",  ~/~/ Адрес события
++
++"objects": [    ~/~/Объекты для ретрансляции
++
++{
++
++"id": "",     ~/~/ идентификатор пользователя
++
++"name": "string",     ~/~/ Название уведомления
++
++"imei": "string",    ~/~/IMEI объекта
++
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++}
++
++  ],
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"parentId": "",  ~/~/ Guid идентификатор родителя
++
++"deleted": true ~/~/ Признак удаления
++
++}
++
++
++==== **Редактирование ретранслятора** ====
++
++(% class="box infomessage" %)
++(((
++**PUT** **/api/v3/retranslations**
++)))
++
++Пример запроса:
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"description": "string",  ~/~/ Определяет описание
++
++"subscriberId": "",  ~/~/ идентификатор запроса
++
++"protocolType": 0,  ~/~/ Тип протокола
++
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"address": "string",   ~/~/ Адрес события
++
++"objects":  ~/~/Объекты для ретрансляции
++
++[
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"imei": "",       ~/~/IMEI объекта
++
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++}
++
++  ]
++
++}
++
++
++Пример ответа:
++
++{
++
++"description": "",  ~/~/ Определяет описание
++
++"subscriberId": "",  ~/~/ идентификатор запроса
++
++"protocolType": 0,  ~/~/ Тип протокола
++
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"address": "string",  ~/~/ Адрес события
++
++"objects": [     ~/~/Объекты для ретрансляции
++
++{
++
++"id": "",    ~/~/ идентификатор пользователя
++
++"name": "string",  ~/~/ Название уведомления
++
++"imei": "",      ~/~/IMEI объекта
++
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++}
++
++  ],
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"parentId": "",  ~/~/ Guid идентификатор родителя
++
++"deleted": true ~/~/ Признак удаления
++
++}
++
++
++
++==== **Получение списка ретранслятора клиента** ====
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/retranslations/find**
++)))
++
++Пример запроса:
++
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
++"search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
++
++"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
++
++}
++
++
++
++Ответ
++
++
++[
++
++{
++
++"description": "",    ~/~/ Определяет описание
++
++"subscriberId": "",    ~/~/ идентификатор запроса
++
++"protocolType": 0,     ~/~/ Тип протокола
++
++"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"address": "string",    ~/~/ Адрес события
++
++"id": "",    ~/~/ идентификатор пользователя
++
++"parentId": "",    ~/~/ Guid идентификатор родителя
++
++"deleted": true   ~/~/ Признак удаления
++
++}
++
++]
++
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
++
++
++==== **API для отчета по выгрузке комбайнов** ====
++
++
++(% class="box infomessage" %)
++(((
++POST **/api/v3/Reports/harvesterUnloading**
++)))
++
++Пример запроса:
++
++
++{
++
++  "byTime": 0, ~/~/ Объединение событий по времени
++
++  "byDist": 0,  ~/~/ Объединение событий по расстоянию
++
++  "filterByTime": 0,   ~/~/ Фильтрация событий по времени нахождения
++
++  "filterByHalfPerimeter": true,  ~/~/ Фильтрация событий по пробегу половины периметра
++
++  "showNearestObjects": true,  ~/~/Показывать объекты рядом?
++
++  "vehicleIds": [   ~/~/ Список id объектов для анализа
++
++    0
++
++  ],
++
++  "from": "", ~/~/ Дата и время начало запроса
++
++  "to": "",  ~/~/ Дата и время окончания запроса
++
++  "timezone": 0  ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++
++}
++
++
++
++Пример ответа:
++
++
++[
++
++  {
++
++    "harvesterName": "",  ~/~/Комбайн, номер
++
++    "harvesterId": 0, ~/~/Комбайн, id
++
++"harvesterModel": "", ~/~/ Модель комбайна
++
++ "hopperCapacity": 0, ~/~/ Объем бункера м3
++
++    "hopperDischargeSpeed": 0,  ~/~/ Скорость выгрузки из бункера, л/сек
++
++    "events": [  ~/~/Список событий в разрезе комбайна
++
++      {
++
++        "driverId": "",  ~/~/Идентификатор водителя
++
++        "driverName": "", ~/~/Водитель комбайна, ФИО
++
++        "RFID": "", ~/~/ идентификатор карты-метки
++
++        "rfidName": "", ~/~/Водитель комбайна, имя метки
++
++        "vehicleId": 0, ~/~/идентификатор объекта
++
++        "vehicleName": "string", ~/~/ Имя объекта
++
++        "modelName": "string", ~/~/  Имя модели объекта
++
++        "nearestVehicles": [  ~/~/Объекты рядом
++
++          {
++
++            "vehicleId": 0, ~/~/идентификатор объекта
++
++            "vehicleName": "string" ~/~/ Имя объекта
++
++          }
++
++        ],
++
++        "fields": [  ~/~/Поля, где происходила выгрузка
++
++          {
++
++            "id": 0, ~/~/ идентификатор пользователя
++
++            "name": "string" ~/~/ имя пользователя
++
++          }
++
++        ],
++
++        "event": "string", ~/~/Событие
++
++        "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
++
++        "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
++
++        "durationSeconds": 0,  ~/~/Продолжительность события, в секундах
++
++        "cultureName": "string",  ~/~/ название культуры
++
++        "bunkerLowLevelStart": 0,  ~/~/Бункер, нижний уровень (на начало события)
++
++        "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
++
++        "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
++
++        "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
++
++        "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
++
++        "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
++
++        "issued": 0, ~/~/Выдано, бункеров
++
++        "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
++
++        "latitude": 0,  ~/~/Широта
++
++        "longitude": 0, ~/~/ Долгота
++
++        "litresAway": 0, ~/~/Отдано, л
++
++        "m3Away": 0 ~/~/Отдано, м3
++
++      }
++
++    ]
++
++  }
++
++]
++
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
++
++
++(% class="box infomessage" %)
++(((
++GET api/v3/Vehicles/recyclebin/all
++)))
++
++Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
++
++Параметр запроса: {parentId} - идентификатор агента
++
++В заголовках запроса: X-Auth: Токен авторизации
++
  Ответ:
++[
++
    {
--    "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
++    "recordTime": "",  ~/~/Время записи
--    " driver ": "string", ~/~/ Имя водителя
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
--    "amount": 0, ~/~/ Количество топлива
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
--    "amountDut": 0, ~/~/ Количество топлива по ДУТ
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
--    "amountDiff": 0, ~/~/ Разница в литрах
++    "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
--    "amountDiffPerc": 0, ~/~/ Разница в %
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--    "summa": 0, ~/~/  Стоимость в руб.
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
--    "serviceName": "string", ~/~/ Тип топлива
++      "items": [ ~/~/ [
--    "price": 0, ~/~/ Цена за литр в руб.
++nullable: true  ~/~/Детали
--    "cardName": "string", ~/~/ Наименование ТК
++        {
--    "cardNum": "string", ~/~/ Номер ТК
++          "name": "string", ~/~/наименование столбца
--    "operator": "string", ~/~/ Оператор ТК
++          "value": "string" ~/~/содержание столбца
--    "address": "string", ~/~/ Адрес АЗС
++        }
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
++      ]
++    },
++
++    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++
++      "string"
++
++    ]
++
    }
--
++]
++
++
++(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
++
++(% class="box infomessage" %)
++(((
++POST/api/v3/Vehicles/recyclebin/erase
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Пример запроса:
++
++
++[
++
++  0
++
++]
++
++
++Пример ответа:
++
++[
++
++  {
++
++    "recordTime": "", ~/~/Время записи
++
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++
++    "objectId": 0, ~/~/ID объекта, помещённого в корзин
++
++    "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
++
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++
++      "items": [ ~/~/Детали
++
++        {
++
++          "name": "", ~/~/Имя свойства
++
++          "value": "" ~/~/Значение свойства
++
++        }
++
++      ]
++
++    },
++
++    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++
++      ""
++
++    ]
++
++  }
++
++]
++
++Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++
++== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
++
++(% class="box infomessage" %)
++(((
++POST/api/v3/Vehicles/recyclebin/restore
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
++Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Пример запроса:
++
++[
++
++  0
++
++]
++
++
++Пример ответа:
++
++[
++
++  {
++
++    "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
++
++    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/Guid пользователя, добавившего объект в корзину
++
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
++
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++
++    "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
++
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++
++      "items": [ ~/~/Детали
++
++        {
++
++          "name": "string",  ~/~/Имя свойства
++
++          "value": "string" ~/~/Значение свойства
++
++        }
++
++      ]
++
++    },
++
++    "errors": [ ~/~/Список ошибок удаления/восстановления объекта
++
++      "string"
++
++    ]
++
++  }
++
++]
++
++
++
  (% class="box" lang="en-US" style="text-align: center;" %)
  (((
  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

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

Summary

Details

Меню