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

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

From version < 103.3 >

edited by Илья Крайнов
on 2023/08/03 17:32

To version < 105.1 >

edited by Илья Крайнов
on 2023/08/09 17:59

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1504,65 +1504,136 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
--(% style="text-align:left" %)
--(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**
++== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
--== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
--
  (% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
++(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
--(% style="color:#000000" %)Метод запроса: **POST**
++(% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="text-align:left" %)
--Тело запроса:
++(% style="color:#000000" %)Ответ:
++(% style="color:#000000" %){
++
++    "id": "", ~/~/ ID типа датчика
++    "name": "", ~/~/ Название
++    "description": "", ~/~/ Описание
++
  (% style="text-align:left" %)
++(% style="color:#000000" %)}
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
++
++(% class="box infomessage" style="text-align: left;" %)
++(((
++**POST /api/v3/terminalMessages/count**
++)))
++
++(% style="text-align: left;" %)
++Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align: left;" %)
  {
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++  "vehicleIds": [
++    id ~/~/ здесь передается список идентификаторов объектов
++  ],
++  "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
++  "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
  }
--(% style="text-align:left" %)
++(% style="text-align: left;" %)
  Ответ:
++(% style="text-align: left;" %)
  [
    {
--    "id": 0, ~/~/ Идентификатор объекта геозоны
--    "name": "string", ~/~/ Название объекта геозоны
--    "type": 0, ~/~/ Тип объекта геозоны
--    "fname": "string", ~/~/ Имя файла
--    "parentId": "string", ~/~/ Идентификатор клиента
--    "radius": 0, ~/~/ Радиус геообъекта
--    "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
--    "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
--    "description": "string", ~/~/ Описание
--    "area": 0, ~/~/ Площадь, м^^2^^
--    "perimetr": 0, ~/~/ Периметр, м
--    "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
++    "vehicleId": 0, ~/~/ идентификатор объекта
++    "count": 0 ~/~/ количество сообщений за период
    }
  ]
--== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
  (% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
++**POST /api/v3/terminalMessages**
  )))
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
++Метод возвращает список сообщений терминала объекта за выбранный период.
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "vehicleId": 0, ~/~/ id объекта
++  "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
++  "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
++}
++
++Ответ:
++
++[
++  {
++    "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": { ~/~/ список параметров датчиков передаваемых терминалом
++          "additionalProp1": "string",
++          "additionalProp2": "string",
++          "additionalProp3": "string"
++        },
++        "photoCount": 0 ~/~/ Кол-во фото
++      }
++    ]
++  }
++]
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных о объекте за период**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
++)))
++
  (% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -1570,40 +1570,42 @@
  Тело запроса:
  {
--  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
--  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
--  "ids": [ ], ~/~/ Массив id объектов
--  "byTime": 0, ~/~/ Настройки фильтрации по времени
--  "byDist": 0, ~/~/
--  "filterByTime": 0, ~/~/
--  "filterByHalfPerimeter": true ~/~/
++  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "vehicleIds": [0], ~/~/ Список ID объектов
++  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
++  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
  }
  Ответ:
++
  [
    {
--    "geozoneId": 0,
--    "geozoneName": "string",
--    "startDate": "2023-08-02T06:13:18.554Z",
--    "endDate": "2023-08-02T06:13:18.554Z",
--    "duration": 0,
--    "vehicleId": 0,
--    "vehicleName": "string"
++    "vehicleId": 0, ~/~/ ID объекта
++    "name": "string", ~/~/ Имя ТС
++    "periods": [ ~/~/ Периоды
++      {
++        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
++        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
++        "mileageBegin": 0, ~/~/ Пробег на начало периода
++        "mileageEnd": 0, ~/~/ Пробег на окончание периода
++        "motohoursBegin": 0, ~/~/ Моточасы на начало периода
++        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
++      }
++    ]
    }
  ]
--== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
  (% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
  )))
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
--
  (% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -1611,15 +1611,11 @@
  Тело запроса:
  {
--  "startDate": "2023-08-03T14:20:03.439Z",
--  "endDate": "2023-08-03T14:20:03.439Z",
--  "ids": [
--    0
--  ],
--  "byTime": 0,
--  "byDist": 0,
--  "filterByTime": 0,
--  "filterByHalfPerimeter": true
++  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "vehicleIds": [0], ~/~/ Список ID объектов
++  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
++  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
  }
  Ответ:
@@ -1626,110 +1626,178 @@
  [
    {
--    "geozoneId": 0,
--    "geozoneName": "string",
--    "startDate": "2023-08-02T06:13:18.554Z",
--    "endDate": "2023-08-02T06:13:18.554Z",
--    "duration": 0,
--    "vehicleId": 0,
--    "vehicleName": "string"
++    "vehicleId": 0, ~/~/ ID объекта
++    "name": "string", ~/~/ Имя ТС
++    "periods": [ ~/~/ Периоды
++      {
++        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
++        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
++        "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
++        "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
++        "fuelConsumption": 0, ~/~/ Расход топлива
++        "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
++      }
++    ]
    }
  ]
++== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
++(% class="box infomessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
++)))
++(% style="color:#000000" %)Метод запроса: **POST**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
--== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% style="text-align:left" %)
++Тело запроса:
++
++{
++  "vehicleIds": [0], ~/~/ Список ID объектов
++  "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
++  "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Ответ:
++
++[
++  {
++    "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
++    "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
++    "vehicleId": 0, ~/~/ ID объекта
++    "name": "string", ~/~/ Имя объекта
++    "model": "string", ~/~/ Модель объекта
++    "fuels": [ ~/~/ Массив данным по заправкам и сливам
++      {
++        "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
++        "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
++        "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
++        "valueFuel": 0, ~/~/ Количество
++        "fuelStart": 0, ~/~/ Уровень топлива на начало события
++        "fuelEnd": 0 ~/~/ Уровень топливо на конец события
++      }
++    ]
++  }
++]
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
++
  (% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
--(% style="color:#000000" %)Метод запроса: **GET**
++(% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Ответ:
++(% style="text-align:left" %)
++Тело запроса:
--(% style="color:#000000" %){
++(% style="text-align:left" %)
++{
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++}
--    "id": "", ~/~/ ID типа датчика
--    "name": "", ~/~/ Название
--    "description": "", ~/~/ Описание
--
  (% style="text-align:left" %)
--(% style="color:#000000" %)}
++Ответ:
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
++[
++  {
++    "id": 0, ~/~/ Идентификатор объекта геозоны
++    "name": "string", ~/~/ Название объекта геозоны
++    "type": 0, ~/~/ Тип объекта геозоны
++    "fname": "string", ~/~/ Имя файла
++    "parentId": "string", ~/~/ Идентификатор клиента
++    "radius": 0, ~/~/ Радиус геообъекта
++    "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
++    "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
++    "description": "string", ~/~/ Описание
++    "area": 0, ~/~/ Площадь, м^^2^^
++    "perimetr": 0, ~/~/ Периметр, м
++    "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
++  }
++]
--== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
--(% class="box infomessage" style="text-align: left;" %)
++(% class="box infomessage" %)
  (((
--**POST /api/v3/terminalMessages/count**
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
  )))
--(% style="text-align: left;" %)
--Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
++(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
--(% style="text-align: left;" %)
--Метод запроса **POST**
++(% style="color:#000000" %)Метод запроса: **POST**
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
--(% style="text-align: left;" %)
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="text-align: left;" %)
++(% style="text-align:left" %)
++Тело запроса:
++
  {
--  "vehicleIds": [
--    id ~/~/ здесь передается список идентификаторов объектов
--  ],
--  "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
--  "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
++  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
++  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
++  "ids": [ ], ~/~/ Массив id объектов
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "byDist": 0, ~/~/ Объединение событий по расстоянию
++  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
++  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
  }
--(% style="text-align: left;" %)
  Ответ:
--
--(% style="text-align: left;" %)
  [
    {
--    "vehicleId": 0, ~/~/ идентификатор объекта
--    "count": 0 ~/~/ количество сообщений за период
++    "geozoneId": 0, ~/~/ ID геообъекта
++    "geozoneName": "string", ~/~/ Название геообъекта
++    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
++    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
++    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
++    "vehicleId": 0, ~/~/ ID объекта
++    "vehicleName": "string" ~/~/ Имя объекта
    }
  ]
--== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
  (% class="box infomessage" %)
  (((
--**POST /api/v3/terminalMessages**
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
  )))
--Метод возвращает список сообщений терминала объекта за выбранный период.
++(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
--(% style="text-align: left;" %)
--Метод запроса **POST**
++(% style="color:#000000" %)Метод запроса: **POST**
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
--(% style="text-align: left;" %)
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% style="text-align:left" %)
++Тело запроса:
++
  {
--  "vehicleId": 0, ~/~/ id объекта
--  "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
--  "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
++  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
++  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
++  "ids": [ ], ~/~/ Массив id геообъектов
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "byDist": 0, ~/~/ Объединение событий по расстоянию
++  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
++  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
  }
  Ответ:
@@ -1736,24 +1736,13 @@
  [
    {
--    "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": { ~/~/ список параметров датчиков передаваемых терминалом
--          "additionalProp1": "string",
--          "additionalProp2": "string",
--          "additionalProp3": "string"
--        },
--        "photoCount": 0 ~/~/ Кол-во фото
--      }
--    ]
++    "geozoneId": 0, ~/~/ ID геообъекта
++    "geozoneName": "string", ~/~/ Название геообъекта
++    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
++    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
++    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
++    "vehicleId": 0, ~/~/ ID объекта
++    "vehicleName": "string" ~/~/ Имя объекта
    }
  ]

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

Summary

Details

Меню