Проверка в реестре залогов движимого имущества по VIN¶

checkRzVin¶

Тип HTTP запроса: POST

URL вызова: https://api.id-x.org/idx/api2/checkRzVin

Поддерживаются следующие форматы передачи параметров:

JSON, Content-Type: application/json
Form submit, Content-Type: application/x-www-form-urlencoded

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
vin	String	Нет	Идентификационный номер транспортного средства (VIN)
pin	String	Нет	Идентификационный номер транспортного средства (product identification number, PIN)
bodyNumber	String	Нет	Номер кузова

Требуется VIN, либо PIN, либо Номер кузова.

Функция возвращает:

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
found	Boolean	Нет	Признак обнаружения информации (True, если информация найдена, False, если информацию обнаружить не удалось)
data	Array	Нет	Массив объектов, описывающих уведомления о залоге движимого имущества. Если found == false, то возвращается пустой массив. Подробнее см. уведомление о залоге

Пример вызова (передача параметров в формате json):

POST /idx/api2/checkRzVin
Host: api.id-x.org
Content-Type: application/json
Accept: application/json

{
    "accessKey": "Выданный accessKey", 
    "secretKey": "Выданный secretKey", 
    "vin": "LVTDD00B8PD123456"
}

Пример ответа (результат в формате json):

{
    "resultCode": 0,
    "operationToken": "f8a41353058b4c92b5fbcd18e9aef3b8",
    "startMoment": "01.12.2023 11:20:59",
    "stopMoment": "01.12.2023 11:22:17",
    "found": true,
    "data": [*Уведомление о залоге*]
}