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

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

From version < 114.1 >

edited by Илья Крайнов
on 2023/10/20 16:06

To version < 141.1 >

edited by Андрей Калиновский
on 2024/02/28 10:46

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

@@ -171,9 +171,8 @@
  (% style="color:#000000" %)Ответ:
  {
--    "agentId": "",(% style="color:#000000" %)   (%%)
++    "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" %)**Добавление пользователя**(%%) ==
@@ -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,51 @@
    }
  ]
++== (% 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|Номер входа
++
  == (% 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,80 +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="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
++|=(% 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 типа протокола
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/export/history**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--{
--  "vehicleId": 0, ~/~/ ID объекта
--  "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
--  "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
--  "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
--}
--
--Ответ:
--
--Получаете файл. Сообщение: Code 200/Success
--
--== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/vehicles/export/history/status**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **GET**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ:
--
--{
--  "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
--  "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
--  "message": "string" ~/~/ текст описывающий статус.
--}
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
@@ -2109,6 +2109,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,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
++    "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" %)**Получение списка всех геообъектов**(%%) ==
@@ -3007,6 +3007,83 @@
  Success
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/Trailers**
++)))
++
++Пример запроса:
++
++{
++  "startDate": "2023-11-14T10:48:03.671Z",
++  "endDate": "2023-11-14T10:48:03.671Z",
++  "ids": [ 0 ],
++  "timezone": 0
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
++|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
++|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
++|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
++
++Пример ответа:
++
++[
++  {
++    "SD": "2023-11-14T10:48:03.717Z",
++    "ED": "2023-11-14T10:48:03.717Z",
++     "id": 0,
++    "SLat": 0,
++    "SLon": 0,
++    "ELat": 0,
++    "ELon": 0,
++    "mileage": 0
++    "Duration": 0
++    "Address": "string",
++    "Address2": "string",
++    "name": "string",
++    "rid": "string",
++    "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "trailer": {
++      "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "Number": "string",
++      "Description": "string",
++      "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "ExternalID": "string",
++      "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "CreateTime": "2023-11-14T10:48:03.717Z",
++      "UpdateTime": "2023-11-14T10:48:03.717Z",
++      "IsDeleted": true
++    },
++    "filesCount": 0,
++  }
++]
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|SD|Дата и время начала события
++|ED|Дата и время окончания события
++|id|ID объекта
++|SLat|Широта начальной координаты
++|SLon|Долгота начальной координаты
++|ELat|Широта конечной координаты
++|ELon|Долгота конечной координаты
++|mileage|Пробег
++|Duration|Продолжительность
++|Address|Адрес начального местоположения
++|Address2|Адрес конечного местоположения
++|name|Имя радиометки
++|rid|Номер радиометки
++|rguid|ID радиометки
++|trailer|Информация об агрегате
++|ModelGuid|ID агрегата
++|Number|Название/номер агрегата
++|Description|Текст примечания агрегата
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
@@ -3028,13 +3028,19 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 0,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "deleted": true
    }
  ]
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|parentId|ID клиента
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++
  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
  (% class="box infomessage" %)
@@ -3050,13 +3050,19 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 0,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "deleted": true
    }
  ]
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
++
  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
  (% class="box successmessage" %)
@@ -3071,7 +3071,6 @@
    "number": 0,
    "period": 0,
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
  Ответ:
@@ -3082,9 +3082,15 @@
    "period": 0,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
++
  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
  (% class="box warningmessage" %)
@@ -3100,7 +3100,6 @@
    "period": 0,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
  Ответ:
@@ -3111,9 +3111,15 @@
    "period": 0,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
++
  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
  (% class="box errormessage" %)
@@ -3362,6 +3362,8 @@
  **PUT /api/v3/Billing/client/balance**
  )))
++Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
++
  Тело запроса:
  {
@@ -3375,6 +3375,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" %)
@@ -3447,6 +3447,305 @@
  |PeriodValue|Значение периода.
  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
++
++(% class="box warningmessage" %)
++(((
++Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
++)))
++
++== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/import/{agentId}**
++)))
++
++Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
++
++В пути указывается **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}**
++)))
++
++(% class="wikigeneratedid" %)
++Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **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" %)
++(((
++**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" %)
++(((
++**POST /api/v3/vehicles/export**
++)))
++
++Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
++
++Тело запроса:
++
++[
++  id
++]
++
++Ответ: Success 200, получаете файлы с настройками.
++
++== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/export/history**
++)))
++
++Метод возвращает список сообщений терминала объекта за выбранный период.
++
++Тело запроса:
++
++{
++  "vehicleId": 0,
++  "asArchive": true,
++  "from": "2023-09-27T12:17:45.973Z",
++  "to": "2023-09-27T12:17:45.973Z"
++}
++
++Ответ:
++
++Получаете файл. Сообщение: Code 200/Success
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleId|ID объекта
++|asArchive|true - Архивировать файл, False - не архивировать
++|from|Дата и время начала запроса
++|to|Дата и время окончания запроса
++
++== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/vehicles/export/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|Прогресс экспорта, от 0 до 100%
++|message|Текст описывающий статус
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/EcoDriving/rating**
++)))
++
++Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
++
++Тело запроса:
++
++{
++  "vehicleIds": [vehicleId],
++  "from": "2023-11-22T09:29:48.051Z",
++  "to": "2023-11-22T09:29:48.051Z"
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleIds|Массив ID объектов
++|from|Дата начала запроса
++|to|Дата окончания запроса
++
++Ответ:
++
++{
++  "items": [
++    {
++      "from": "2023-11-22T09:29:48.052Z",
++      "to": "2023-11-22T09:29:48.052Z",
++      "vehicleId": 0,
++      "vehicleName": "string",
++      "vehicleModel": "string",
++      "penalty": 0,
++      "score": 0,
++      "totalViolations": 0,
++      "violationsByType": {
++        "overspeedingViolations": 0,
++        "accelerationViolations": 0,
++        "brakingViolations": 0,
++        "turningViolations": 0,
++        "dangerousDrivingViolations": 0,
++        "sensorViolations": 0
++      },
++      "moveTime": 0,
++      "mileage": 0,
++      "tripsCount": 0,
++      "trips": [
++        {
++          "penalty": 0,
++          "score": 0,
++          "violationsCount": 0,
++          "violationsByType": {
++            "overspeedingViolations": 0,
++            "accelerationViolations": 0,
++            "brakingViolations": 0,
++            "turningViolations": 0,
++            "dangerousDrivingViolations": 0,
++            "sensorViolations": 0
++          },
++          "moveTime": 0,
++          "mileage": 0,
++          "motohours": 0,
++          "maxSpeed": 0,
++          "startAddress": "string",
++          "endAddress": "string",
++          "drivers": [
++            {
++              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++              "driverName": "string",
++              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++            }
++          ]
++        }
++      ]
++    }
++  ]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|from|Дата начала запроса
++|to|Дата  окончания
++|vehicleId|ID объекта
++|vehicleName|Имя объекта
++|vehicleModel|Модель объекта
++|penalty|Сумма штрафных баллов
++|score|Оценка
++|totalViolations|Суммарное количество нарушений
++|violationsByType|Список типов нарушений и количество нарушений для каждого типа
++|overspeedingViolations|Превышение скорости
++|accelerationViolations|Ускорение
++|brakingViolations|Торможение
++|turningViolations|Резкий поворот
++|dangerousDrivingViolations|Резкое вождение
++|sensorViolations|Нарушение по датчику
++|moveTime|Время в движении
++|mileage|Пробег
++|tripsCount|Количество рейсов
++|motohours|Моточасы
++|maxSpeed|Максимальная скорость
++|startAddress|Адрес начала рейса
++|endAddress|Адрес окончания рейса
++|drivers|Список водителей, которые были на объекте в течениии рейса
++|driverGuid|Guid водителя
++|driverName|Имя водителя
++|driverRfid|Номер Карты-метки
++
  (% 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

Меню