Создание машины¶

Создание машины

Запрос (Request)¶

POST-запрос¶

https://server.sedi.ru:9031/api/SeDiExternalSystems/create-car/

Заголовки (Headers)¶

Название	Описание
X-Api-Key	API-ключ
X-Client-ID	Ключ, определяющий партнера

Параметры¶

Название	Описание
park_profile	Свойства машины. Тип: ParkProfile
vehicle_licenses	Данные документов машины. Тип: VehicleLicenses
vehicle_specifications	Основные данные машины. Тип: VehicleSpecifications
child_safety	Детские кресла типа бустер, указывается количество

ParkProfile¶

Название	Описание
amenities	Удобства в ТС. Допустимые значения: `conditioner`, `wifi`, `check`, `card`, `woman_driver`, `post_terminal`, `no_smoking`, `smoking`, `child_chair`, `animal_transport`, `universal`

VehicleLicenses¶

Название	Описание
licence_plate_number	Номер машины. Тип: `String`
licence_number	Номер лицензии на такси. Тип: `String`
registration_certificate	номер СТС. Тип: `String`

VehicleSpecifications¶

Название	Описание
brand	Марка машины. Тип: `String`
model	Модель машины. Тип: `String`
color	Цвет машины. Тип: `String`
year	Год выпуска машины. Тип: `Int`
vin	VIN-номер машины. Тип: `String`

Пример тела запроса¶

{    
"park_profile": 
    {
        "amenities":[
                     "conditioner",
                     "animal_transport",
                     "universal"
                    ]
    },
"child_safety": 
    {
        "booster_count": 1
    },
"vehicle_licenses": 
    {
        "licence_plate_number": "О222О22",
        "registration_certificate": "123456789",
        "licence_number": "123456789"
    },
 "vehicle_specifications": 
    {
        "model": "Golf",
        "brand": "Volkswagen",
        "color": "Синий",
        "year": 2020,
        "vin": "12345678909876543"
    }
}

Ответ¶

200 OK¶

Машина создана успешно

{
  "vehicle_id": 123 // ID созданной машины
}

403 Forbidden¶

Некорректный API KEY.

400 BadRequest¶

Некорректные параметры запроса или пустые заголовки.

500 InternalServerError¶

Ошибка в процессе выполнения запроса

Error. Ошибка добавления¶

{
  "code": "код ошибки",
  "message": "текстовое описание ошибки"
}