Работа с транспортными средствами

Получение списка транспортных средств

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

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

Параметры вызова

В запросе используется обязательный параметр withCustomTemplateItems — нужно ли отображать дополнительные поля (true — нужно возвращать, false — без дополнительных полей).

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

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

Параметр	Описание
name	Имя транспортного средства
vehicleID	ИД для получения характеристик транспортного средства
subscriberID	ИД транспортного средства
garageNumber	Гаражный номер
licensePlate	Государственный регистрационный номер транспортного средства
vin	VIN-номер транспортного средства
customFieldFormTemplateID	ИД шаблона дополнительных полей транспортного средства
Параметры дополнительных полей транспортного средства (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/vehicleManagement/vehicles?withCustomTemplateItems=\{boolean} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/vehicleManagement/vehicles?withCustomTemplateItems=true HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
  \{
    "name": "string",
    "vehicleID": integer,
    "subscriberID": integer,
    "garageNumber": "string",
    "licensePlate": "string",
    "vin": "string",
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
      \{
        "externalID": "string",
        "name": "string",
        "value": "string",
        "type": "string"
      }
    ]
  },
  \{
    "name": "string",
    "vehicleID": integer,
    "subscriberID": integer,
    "garageNumber": "string",
    "licensePlate": "string",
    "vin": "string",
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
      \{
        "externalID": "string",
        "name": "string",
        "value": "string",
        "type": "string"
      }
    ]
  }
]

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

[
  \{
    "name": "Иванов Николай",
    "vehicleID": 1,
    "subscriberID": 1,
    "garageNumber": "123",
    "licensePlate": "C123CC177",
    "vin": "JMZGG128241207606",
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
      \{
        "externalID": "1",
        "name": "цвет",
        "value": "белый",
        "type": "string"
      }
    ]
  },
  \{
    "name": "Петров Василий",
    "vehicleID": 2,
    "subscriberID": 2,
    "garageNumber": "123",
    "licensePlate": "E123EE177",
    "vin": "JN1TBNT30U0124100",
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
      \{
        "externalID": "1",
        "name": "цвет",
        "value": "черный",
        "type": "string"
      }
    ]
  }
]

Получение транспортного средства по идентификатору его характеристик

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

Функция позволяет получить транспортное средство по идентификатору его характеристик.

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

В запросе используется обязательный параметр vehicleID — идентификатор для получения характеристик транспортного средства.

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

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

Параметр	Описание
name	Имя транспортного средства
vehicleID	ИД для получения характеристик транспортного средства
subscriberID	ИД транспортного средства
garageNumber	Гаражный номер
licensePlate	Государственный регистрационный номер транспортного средства
vin	VIN-номер транспортного средства
customFieldFormTemplateID	ИД шаблона дополнительных полей транспортного средства
Параметры дополнительных полей транспортного средства (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:>string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/vehicleManagement/vehicles/\{vehicleID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/vehicleManagement/vehicles/2 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
  "name": "string",
  "vehicleID": integer,
  "subscriberID": integer,
  "garageNumber": "string",
  "licensePlate": "string",
  "vin": "string",
  "customFieldsFormTemplateID": integer,
  "customFieldFormItems": [
    \{
      "externalID": "string",
      "name": "string",
      "value": "string",
      "type": "string"
    }
  ]
}

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

\{
  "name": "Петров Василий",
  "vehicleID": 2,
  "subscriberID": 2,
  "garageNumber": "123",
  "licensePlate": "E123EE177",
  "vin": "JN1TBNT30U0124100",
  "customFieldsFormTemplateID": 1,
  "customFieldFormItems": [
    \{
      "externalID": "1",
      "name": "цвет",
      "value": "черный",
      "type": "string"
    }
  ]
}

Получение транспортного средства по его идентификатору

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

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

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

В запросе используется обязательный параметр subscriberID — идентификатор транспортного средства.

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

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

Параметр	Описание
name	Имя транспортного средства
vehicleID	ИД для получения характеристик транспортного средства
subscriberID	ИД транспортного средства
garageNumber	Гаражный номер
licensePlate	Государственный регистрационный номер транспортного средства
vin	VIN-номер транспортного средства
customFieldFormTemplateID	ИД шаблона дополнительных полей транспортного средства
Параметры дополнительных полей транспортного средства (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы:>string – строка;text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/vehicleManagement/subscriberID/\{subscriberID}  HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/vehicleManagement/subscriberID/2 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
  "name": "string",
  "vehicleID": integer,
  "subscriberID": integer,
  "garageNumber": "string",
  "licensePlate": "string",
  "vin": "string",
  "customFieldsFormTemplateID": integer,
  "customFieldFormItems": [
    \{
      "externalID": "string",
      "name": "string",
      "value": "string",
      "type": "string"
    }
  ]
}

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

\{
  "name": "Петров Василий",
  "vehicleID": 2,
  "subscriberID": 2,
  "garageNumber": "123",
  "licensePlate": "E123EE177",
  "vin": "JN1TBNT30U0124100",
  "customFieldsFormTemplateID": 1,
  "customFieldFormItems": [
    \{
      "externalID": "1",
      "name": "цвет",
      "value": "черный",
      "type": "string"
    }
  ]
}

Получение датчиков по идентификатору транспортного средства

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

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

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

В запросе используется обязательный параметр vehicleID — идентификатор транспортного средства.

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

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

Параметр	Описание
sensorID	ИД датчика
sensorType	Тип датчика
name	Название датчика
description	Описание датчика
unit	Единица измерений показаний датчика
min	Минимальное значение датчика
max	Максимальное значение датчика
isVirtual	Является ли датчик виртуальным. Существуют следующие значения: true — является; false — не является.
isFuel	Является ли датчик датчиком топлива. Существуют следующие значения: true — является; false — не является.
isIgnition	Является ли датчик датчиком зажигания. Существуют следующие значения: true — является; false — не является.
sensorLegendID	ИД легенды значений датчика
valueType	Тип данных датчика. Существуют следующие значения: 0 — по умолчанию; 1 — вещественное число double; 2 — булевое bool; 3 — целое число int; 4 — массив байт blob; 5 — строка; 16 — битовый признак обратного порядка байт.

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

GET /v6/api/vehicleManagement/vehicles/\{vehicleID}/sensors HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/vehicleManagement/vehicles/1/sensors HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "sensorID": integer,
        "sensorType": integer,
        "name": "string",
        "description": "string",
        "unit": "string",
        "min": number,
        "max": number,
        "isVirtual": boolean,
        "isFuel": boolean,
        "isIgnition": boolean,
        "sensorLegendID": integer,
        "valueType": integer
    }
]

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

[
    \{
        "sensorID": 1,
        "sensorType": 1,
        "name": "Бак топлива",
        "description": "Топливо",
        "unit": "л",
        "min": 1,
        "max": 60,
        "isVirtual": false,
        "isFuel": true,
        "isIgnition": false,
        "sensorLegendID": 1,
        "valueType": 1
    },
    \{
        "sensorID": 2,
        "sensorType": 2,
        "name": "Температура",
        "description": "Температура в холодильнике",
        "unit": "C",
        "min": 1,
        "max": 10,
        "isVirtual": false,
        "isFuel": false,
        "isIgnition": false,
        "sensorLegendID": 2,
        "valueType": 1
    }
]

Работа с транспортными средствами

Получение списка транспортных средств

Получение транспортного средства по идентификатору его характеристик

Получение транспортного средства по его идентификатору

Получение датчиков по идентификатору транспортного средства

Содержание