ИнтеграцияИнтеграция по APIРабота с датчиками транспорта

Работа с датчиками транспорта

Получение типов датчиков

Общее описание

Функция позволяет получить типы датчиков.

Параметры запроса

Функция не имеет дополнительных параметров.

Результат выполнения

Функция возвращает структуру с параметрами типов датчиков:

Параметр Описание
sensorTypeID ИД типа датчика
name Название типа датчика
description Описание типа датчика
creactionDate Дата и время создания типа датчика

Формат запроса

GET /v6/api/sensorManagement/sensors/types HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/sensorManagement/sensors/types HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "sensorTypeID": integer,
        "name": "string",
        "description": "string",
        "creationDate": "string"
    },
    \{
        "sensorTypeID": integer,
        "name": "string",
        "description": "string",
        "creationDate": "string"
    }
]

Пример ответа

[
    \{
        "sensorTypeID": 1,
        "name": "Топливные датчики",
        "description": "Для топлива",
        "creationDate": "2023-12-06T18:28:01+03:00"
    },
    \{
        "sensorTypeID": 2,
        "name": "Датчики температуры",
        "description": "Для температуры",
        "creationDate": "2023-12-06T18:28:01+03:00"
    }
]

Получение значений датчиков по типу

Общее описание

Функция позволяет получить значения датчиков по типу.

Параметры запроса

Функция имеет следующие параметры:

Параметр Описание
sensorTypeID ИД типа датчика
dateFrom Дата и время начала периода, за который нужно получить данные (подробнее о формате времени).
dateTo Дата и время окончания периода, за который нужно получить данные (подробнее о формате времени).
subscriberIDs ИД транспортных средств. Подробнее о передаче нескольких идентификаторов
subscriberGroupIDs ИД групп транспортных средств. Подробнее о передаче нескольких идентификаторов

Результат выполнения

Функция возвращает структуру с параметрами значений датчиков:

Параметр Описание
sensorID ИД датчика
name Название датчика
vehicleID ИД характеристик транспортного средства
subscriberID ИД транспортного средства
subscriberGroupID ИД группы транспортного средства
longitude Географическая долгота адреса (в градусах)
latitude Географическая широта адреса (в градусах)
locationDateTime Дата, время местоположения, где получено значение (подробнее о формате времени).
valueType Тип данных датчика. Существуют следующие значения: 0 — по умолчанию; 1 — вещественное число double; 2 — булевое bool; 3 — целое число int; 4 — массив байт blob; 5 — строка; 16 — битовый признак обратного порядка байт.
sensorValue Значение датчика

Формат запроса

GET /v6/api/sensorManagement/sensors/types/\{sensorTypeID}/values?dateFrom=\{date-rime}&dateTo=\{date-time}&subscriberIDs=\{integer}&subscriberGroupIDs=\{integer} HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/sensorManagement/sensors/types/2/values?dateFrom=2031-12-01&dateTo=2023-12-07&subscriberIDs=1&subscriberGroupIDs=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
  \{
    "sensorID": integer,
    "name": "string",
    "vehicleID": integer,
    "subscriberID": integer,
    "subscriberGroupID": integer,
    "longitude": number,
    "latitude": number,
    "locationDateTime": "string",
    "valueType": integer,
    "sensorValue": "string"
  },
  \{
    "sensorID": integer,
    "name": "string",
    "vehicleID": integer,
    "subscriberID": integer,
    "subscriberGroupID": integer,
    "longitude": number,
    "latitude": number,
    "locationDateTime": "string",
    "valueType": integer,
    "sensorValue": "string"
  }
]

Пример ответа

[
  \{
    "sensorID": 479,
    "name": "Бак 2",
    "vehicleID": 421394,
    "subscriberID": 633314,
    "subscriberGroupID": 132871,
    "longitude": 37.634578704833984,
    "latitude": 55.77260208129883,
    "locationDateTime": "2023-12-06T14:16:11+03:00",
    "valueType": 3,
    "sensorValue": "100"
  },
  \{
    "sensorID": 479,
    "name": "Бак 2",
    "vehicleID": 421394,
    "subscriberID": 633314,
    "subscriberGroupID": 132871,
    "longitude": 37.634578704833984,
    "latitude": 55.77260208129883,
    "locationDateTime": "2023-12-06T14:16:04+03:00",
    "valueType": 3,
    "sensorValue": "100"
  }
]