Проверка перевозчика на участие в инцидентах с кражей грузов с помощью базы данных "Контроль Рисков"

risk/search

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

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

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

• JSON, Content-Type: application/json

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

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
autoGos	String	Нет	Государственный регистрационный номер автомобиля
autoVin	String	Нет	Идентификационный номер транспортного средства (VIN)
trailerGos	String	Нет	Государственный регистрационный номер прицепа
trailerVin	String	Нет	VIN прицепа
ogrn	String	Нет	ОГРН/ОГРНИП перевозчика
externalId	String	Нет	Идентификатор биржи АТИ

Требуется хотя бы один из параметров, чем больше параметров будет указано, тем точнее будет результат.

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

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
list	Array	Нет	Массив найденных записей базы "Контроль Рисков", подробнее см. контроль рисков

Пример вызова:

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

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "autoGos": "А177AA177"
}

Пример успешного ответа, когда данные найдены:

{
        "resultCode": 0,
        "operationToken": "b75d654330d0486ba7dac462984ef92b",
        "list":[*Контроль Рисков*]
}

Пример успешного ответа, когда данные НЕ найдены:

{
        "resultCode": 0,
        "operationToken": "b75d654330d0486ba7dac462984ef92b",
        "list":[]
}

Контроль Рисков

Это объект, содержащий следующие атрибуты:

Атрибут	Тип	Описание
autoGos	String	Государственный регистрационный номер автомобиля
autoVin	String	Идентификационный номер транспортного средства (VIN)
trailerGos	String	Государственный регистрационный номер прицепа
trailerVin	String	VIN прицепа
ogrn	Array	ОГРН/ОГРНИП перевозчика
externalId	Array	Идентификатор биржи АТИ
judNum	String	Номер судебного решения
smiDate	String	Дата упоминания в СМИ (формат ДД.ММ.ГГГГ)

Пример объекта "Контроль Рисков" в формате json:

{
    "autoGos": "А177AA177",
    "autoVin": "12345678901234567",
    "trailerGos": "АA123456",
    "trailerVin": "09876543210987654",
    "ogrn": ["123456789012345", "123456789012"],
    "externalId": ["12345"],
    "judNum": null,
    "smiDate": null
}