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

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

From version < 120.1 >

edited by Илья Крайнов
on 2023/11/27 09:31

To version < 154.3 >

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

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.krainovim
++XWiki.Gadmin

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" %)
@@ -173,7 +173,6 @@
  {
      "agentId": "",(% style="color:#000000" %)   (%%)
      "parentId": "",
--    "parentName": "string",
      "name": "string",
      "fullName": "string",
      "agentInfoType": 0,
@@ -184,7 +184,6 @@
  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента
  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
--|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
  |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
  |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
  |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
@@ -356,6 +356,21 @@
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/agents/{id}/changeStatus/{status}**
++)))
++
++Метод позволяет изменить статус клиента, указанного в запросе.
++
++В пути указывается GUID клиента и статус клиента.
++
++**status **- значение 0 - заблокирован, 1 - активен.
++
++Ответ: Code 204
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
@@ -1193,6 +1193,87 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
++(% class="wikigeneratedid" %)
++=====   =====
++
++(% class="wikigeneratedid" %)
++===== **Получить ответ на отправленную на ТС команду** =====
++
++(% 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="wikigeneratedid" %)
++===== **Список отправленных объекту команд с ответами** =====
++
++(% 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" %)
@@ -1415,7 +1415,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
++(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
@@ -1536,6 +1536,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" %)
@@ -1789,7 +1789,7 @@
  (% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -1872,6 +1872,56 @@
    }
  ]
++== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
++
++(% class="box infomessage" style="text-align: left;" %)
++(((
++**POST /api/v3/terminalMessages/mapping**
++)))
++
++Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "protocolType": 0,
++  "params": ["string"]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|protocolType|ID типа протокола
++|params|(((
++Массив наименований параметров в сообщении
++)))
++
++Ответ:
++
++{
++  "protocolType": 0,
++  "mapping": {
++    "additionalProp1": {
++      "inputType": 0,
++      "inputNumber": 0
++    },
++    "additionalProp2": {
++      "inputType": 0,
++      "inputNumber": 0
++    }
++  }
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|protocolType|Тип протокола
++|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
++|inputNumber|(((
++Номер входа
++)))
++
++(% class="wikigeneratedid" %)
++Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
++
  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
  (% class="box infomessage" %)
@@ -1896,6 +1896,11 @@
    "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleId|ID объекта
++|from|Дата и время начала периода запроса
++|to|Дата и время окончания периода запроса
++
  Ответ:
  [
@@ -1902,25 +1902,43 @@
    {
      "messages": [
        {
--        "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
--        "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
--        "speed": 0, ~/~/ Скорость, км/ч
--        "altitude": 0, ~/~/ Высота, м
--        "latitude": 0, ~/~/ Широта [-90°;90°]
--        "longitude": 0, ~/~/ Долгота [-180°;180°]
--        "satellites": 0, ~/~/ Кол-во спутников
--        "voltage": 0, ~/~/ Напряжение
--        "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
++        "deviceTime": "2023-11-29T07:40:44.052Z",
++        "serverTime": "2023-11-29T07:40:44.052Z",
++        "speed": 0,
++        "altitude": 0,
++        "latitude": 0,
++        "longitude": 0,
++        "satellites": 0,
++        "course": 0,
++        "voltage": 0,
++        "parameters": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
--        "photoCount": 0 ~/~/ Кол-во фото
++        "photoCount": 0,
++        "lbsCorrectedCoords": true,
++        "protocolType": 0
        }
      ]
    }
  ]
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|deviceTime|Время сообщения терминала
++|serverTime|Время когда сообщение поступило на сервер
++|speed|Скорость
++|altitude|Высота над уровнем моря
++|latitude|Широта
++|longitude|Долгота
++|satellites|Кол-во спутников
++|course|Курс
++|voltage|Бортовое напряжение
++|parameters|Список параметров и их значений
++|photoCount|Количество фото
++|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
++|protocolType|ID типа протокола
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
@@ -2054,6 +2054,129 @@
    }
  ]
++
++== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/moveStop**
++)))
++
++Метод запроса: **POST**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Тело запроса:
++
++{
++
++  "vehicleIds": [ ], ~/~/ Список ID объектов
++
++  "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
++
++  "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
++
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++
++}
++
++Ответ:
++
++[
++
++  {
++
++    "vehicleId": 0, ~/~/ ID объекта
++
++    "vehicleName": "string", ~/~/ Имя объекта
++
++    "moves": [      ~/~/ Событие движения
++
++      {
++
++        "mileage": 0, ~/~/ Пробег, км
++
++        "eventId": 0, ~/~/ Идентификатор события
++
++        "eventName": "string", ~/~/ Название события
++
++        "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++
++        "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++
++        "duration": 0 ~/~/ Продолжительность события, секунд
++
++      }
++
++    ],
++
++    "stops": [       ~/~/ События стоянок
++
++      {
++
++        "address": "string", ~/~/ Адрес события
++
++        "eventId": 0, ~/~/ Идентификатор события
++
++        "eventName": "string", ~/~/ Название события
++
++        "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++
++        "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++
++        "duration": 0 ~/~/ Продолжительность события, секунд
++
++
++      }
++
++    ]
++
++  }
++
++]
++
++
++
++== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/getlastdata**
++)))
++
++Метод запроса: **POST**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
++
++Ответ:
++  {
++    "vehicleId": 0, ~/~/Идентификатор объекта.
++    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
++    "vehicleNumber": "string",~/~/Номер объекта.
++    "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
++    "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
++    "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
++    "speed": 0,~/~/Скорость объекта.
++    "course": 0,~/~/Курс движения [0;360]
++    "latitude": 0,~/~/Широта [-90°;90°].
++    "longitude": 0,~/~/Долгота [-180°;180°].
++    "address": "string",~/~/Адрес.
++    "geozones": [ ~/~/Сведения по геозонам.
++      {
++        "id": 0,
++        "name": "string"
++      }
++
++
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
@@ -3406,6 +3406,8 @@
  **PUT /api/v3/Billing/client/balance**
  )))
++Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
++
  Тело запроса:
  {
@@ -3419,6 +3419,50 @@
  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/billing/client/balance/deposit**
++)))
++
++Создает операцию **Пополнение **с указанной суммой
++
++Тело запроса:
++
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
++}
++
++Ответ: Success
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
++|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++
++== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
++
++Создает операцию **Списание **с указанной суммой
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/billing/client/balance/withdraw**
++)))
++
++Тело запроса:
++
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
++}
++
++Ответ: Success
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
++|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++
  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
  (% class="box warningmessage" %)
@@ -3505,22 +3505,95 @@
  **POST /api/v3/vehicles/import/{agentId}**
  )))
--Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp **. В формате **xml **экспортируются объекты из нашей системы.
++Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
--**agentId** - id клиента, указывается в пути запроса. (обязательный)
++В пути указывается **agentId** - id клиента.
++**Заголовок**
++**X-Auth: [токен авторизации]**
++
++**Параметры**
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
++|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
++
++В теле использовать тип **form-data,** тип значения** file**
++
++**Ключи**
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|data|В значении передаем файл объекта, формат **xml** или **wlp **
++|csv|В значении передаем файл датчиков, формат **csv**
++
++Ответ:
++
++{
++  "vehicleId": 0,
++  "name": "string",
++  "errors": ["string"]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleId|ID созданного объекта
++|name|Имя созданного объекта
++|errors|Ошибки и их описание
++
  == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
  (% class="box infomessage" %)
  (((
--**POST /api/v3/vehicles/import/history/{vehicleId}**
++**POST** **/api/v3/vehicles/import/history/{vehicleId}**
  )))
  (% class="wikigeneratedid" %)
--**vehicleId **- id объекта.
++Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
++(% class="wikigeneratedid" %)
++В пути указывается **vehicleId **- id объекта.
++**Заголовок**
++
++**X-Auth: [токен авторизации]**
++
++В теле использовать тип **form-data.**
++
++Ключи:
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|**history**|В значении передавать файл с историей
++
++В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
++
++Ответ:
++
++{
++  "results": [
++    {
++      "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "vehicleId": 0,
++      "errors": [
++        "string"
++      ],
++      "firstMessageDate": "2023-11-28T09:27:58.949Z",
++      "lastMessageDate": "2023-11-28T09:27:58.949Z",
++      "producedCount": 0,
++      "msgCount": 0
++    }
++  ]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|results|Результаты импорта в разрезе ТС
++|vehicleGuid|Guid ТС
++|vehicleId|ID ТС
++|errors|Список ошибок импорта истории (если пустой - нет ошибок)
++|firstMessageDate|Дата первого импортированного сообщения (UTC)
++|lastMessageDate|Дата последнего импортированного сообщения (UTC)
++|producedCount|Кол-во успешно отправленных в шину данных сообщений
++|msgCount|Кол-во обработанных сообщений всего
++
  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
  (% class="box infomessage" %)
@@ -3528,7 +3528,20 @@
  **GET /api/v3/vehicles/import/history/status**
  )))
++Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
++Ответ:
++
++{
++  "activity": true,
++  "progress": 0,
++  "message": "string"
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
++|progress|Guid ТС
++
  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
  (% class="box infomessage" %)
@@ -3598,7 +3598,7 @@
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
  (% class="box infomessage" %)
  (((
@@ -3704,6 +3704,691 @@
  |driverName|Имя водителя
  |driverRfid|Номер Карты-метки
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
++
++Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
++
++(% class="box infomessage" %)
++(((
++POST /api/v3/fuelcards/transactions
++)))
++
++Метод запроса: POST
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
++\\В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
++{
++
++  "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
++
++  "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
++
++  "ids": [
++
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
++
++  ],
++
++  "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" ~/~/Адрес АЗС
++
++  }
++
++
++==== (% 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: Токен авторизации
++
++Ответ:
++
++[
++
++  {
++
++    "recordTime": "",  ~/~/Время записи
++
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++
++    "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
++
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++
++      "items": [ ~/~/ [
++
++nullable: true  ~/~/Детали
++
++        {
++
++          "name": "string", ~/~/наименование столбца
++
++          "value": "string" ~/~/содержание столбца
++
++        }
++
++      ]
++
++    },
++
++    "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

Меню