Транспортные средства компании
Атрибут |
Значение |
Название |
info-radar-vehicle |
Тип |
Адаптер для получения информации по транспортным средствам компании |
Наименование |
Транспортные средства компании |
Версия |
Реализовано 21.07.2025 |
Сервис для получения информации по транспортным средствам компании.
Общая информация
Цель документации — обеспечить полное понимание и возможность эффективного использования сервиса как для конечных пользователей, так и для разработчиков.
Сервис является частью платформы Агредатор. Перед изучением данной документации ознакомьтесь со следующими обязательными документами по интеграции с платформой:
Параметр |
Название |
Тип |
Обязательное |
Пример |
service |
Имя сервиса (всегда info-radar-vehicle ) |
string |
+ |
info-radar-vehicle |
type |
Тип запроса |
string (enum) |
+ |
company_vehicles |
data |
Данные запроса |
object |
+ |
см. ниже |
Типы запросов type
type |
Значение |
company_vehicles |
Получить информацию по транспортным средствам компании. |
Структура data
Параметр |
Название |
Тип |
Обязательное |
Пример |
EntityId |
Идентификатор лица |
string(uuid) |
+ |
"3fa85f64-5717-4562-b3fc-2c963f66afa6" |
EntityType |
Тип лица |
string |
+ |
"Company" |
Описаниe: Уникальный идентификатор лица.
Тип данных: string (uuid)
Обязательное: +
Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
Описаниe: Тип лица (например, компания, физическое лицо и т.п.)
Тип данных: string
Обязательное: +
Пример: Company
Возможные значения: Company, Person, Entrepreneur, ForeignCompany
Параметры ответа
Параметр |
Название |
Обязательное |
Тип |
Пример |
success |
Статус запроса |
+ |
string |
true |
result |
Хеш с результатом |
- |
object |
См. ниже |
exception |
Ошибка |
- |
string |
Что-то пошло не так |
Параметры result
Поле |
Назначение |
Тип |
Обязательное |
Пример |
TotalItems |
Общее число элементов |
integer |
- |
0 |
Items |
Массив найденных транспортных средств |
array[object] |
- |
Items |
Элемент массива
Поле |
Назначение |
Тип |
Пример |
Brand |
Марка транспортного средства |
string |
"GAZ" |
Model |
Модель транспортного средства |
string |
"GAZ 2752 SOBOL" |
BrandAndModel |
Краткое наименование (марка + модель) |
string |
"ГАЗ 2752" |
VehicleCategory |
Категория транспортного средства |
string |
"B" |
ManufactureYear |
Год выпуска |
integer |
2019 |
InitialRegistrationDate |
Дата первой регистрации |
string(date) |
"2019-09-27T00:00:00" |
Price |
Стоимость (если указана) |
number/null |
null |
Пример json запроса
{
"service": "info-radar-vehicle",
"type": "company_vehicles",
"data": {
"EntityId": "769ea1c9-58a9-4b0b-ac7b-054702a22c1a",
"EntityType": "Company"
}
}
Примеры json ответов
{
"success": true,
"result": {
"TotalItems": 2,
"Items": [
{
"Brand": "GAZ",
"Model": "GAZ 2752 SOBOL",
"BrandAndModel": "ГАЗ 2752",
"VehicleCategory": "В",
"ManufactureYear": 2019,
"InitialRegistrationDate": "2019-09-27T00:00:00",
"Price": null
},
{
"Brand": "GAZ",
"Model": "GAZ GAZEL NEXT",
"BrandAndModel": "2824ВJ",
"VehicleCategory": "В",
"ManufactureYear": 2019,
"InitialRegistrationDate": "2019-09-27T00:00:00",
"Price": null
}
]
}
}
Пример ошибки:
{
"success": false,
"exception": "Что-то пошло не так"
}