Проверка регистрационной информации по VIN¶
checkVehicle¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/gibdd/checkVehicle
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| vin | String | Да | Идентификационный номер транспортного средства (VIN) |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -35 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| vehicle | Объект | Нет | Объект «Информация о ТС». Подробнее см. информация о ТС |
| vehiclePassport | Объект | Нет | Объект «Информация о ПТС». Подробнее см. информация о ПТС |
| sts | Объект | Нет | Объект «Информация о СТС». Подробнее см. информация о СТС |
| ownershipPeriods | Список объектов | Нет | Список объектов «Периоды владения». Подробнее см. периоды владения |
Пример вызова (передача параметров в формате json):
POST /idx/api2/gibdd/checkVehicle
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "Выданный accessKey",
"secretKey": "Выданный secretKey ",
"vin": "17-значный VIN"
}
Пример ответа:
{
"resultCode":0,
"operationToken": "3ff6314a75ab4a19a64b2118d3f53825",
"vehicle": {
"engineVolume": "1596",
"color": "Коричневый",
"year": "2012",
"vin": "X9FMJJEEBBCC98765",
"model": "FORD FOCUS",
"category": "B",
"powerHp": "125.12",
"powerKwt": "92.0",
"maxWeight": "1825",
"weightWithoutLoading": "1324",
"lastRegAction": "В связи с изменением собственника (владельца)",
"regNumber": "A001BC777"
},
"vehiclePassport": {
"number": "1234567890",
"issueDate": "2012-05-23"
},
"sts": {
"number": "9980123456",
"issueDate": "2020-08-10"
},
"ownershipPeriods":[
{
"from": "2007-09-19",
"to": "2017-12-16"
},
{
"from": "2017-12-16",
"to": null
}
]
}
Информация о ТС¶
Объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| vin | String | VIN |
| model | String | Марка+модель |
| category | String | Категория ТС |
| year | String | Год выпуска ТС |
| bodyNumber | String | Номер кузова |
| color | String | Цвет |
| engineVolume | String | Объем двигателя |
| powerHp | String | Мощность двигателя, л.с. |
| powerKwt | String | Мощность двигателя, кВт |
| maxWeight | String | Максимальная масса, кг *** |
| weightWithoutLoading | String | Снаряженная масса, кг *** |
| lastRegAction | String | Последнее регистрационное действие *** |
| regNumber | String | Государственный регистрационный номер *** |
Информация о ПТС¶
Объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| number | String | Номер |
| issueDate | String | Дата выдачи |
Информация о СТС¶
Объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| number | String | Номер *** |
| issueDate | String | Дата выдачи *** |
Период владения¶
Объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| from | String | Дата начала владения |
| to | String | Дата окончания владения |