Создание или изменение условия аренды

Cоздает новое условие аренды если c переданным rent_term_id нет условия аренды, иначе изменяет существующее

Request

PUT

https://fleet-api.taxi.yandex.net/v1/parks/vehicles/rent-terms

Headers

Name

Description

X-API-Key*

Type: string

API-ключ

Example: <API-ключ>

Min length: 1

X-Client-ID*

Type: string

Идентификатор клиента

Example: <Идентификатор клиента>

Min length: 1

X-Idempotency-Token*

Type: string

Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов

Example: c56fa6537e5a4adbbce6ef3593210fb9

Min length: 16

Max length: 64

X-Park-ID*

Type: string

Идентификатор партнера

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Body

application/json
{
    "rent_term_id": "string",
    "name": "string",
    "schemas": [
        {
            "working_days": 0,
            "non_working_days": 0,
            "daily_amount": "50.1200"
        }
    ],
    "minimum_period_days": 0,
    "deposit_amount_total": "50.1200",
    "deposit_amount_daily": "50.1200",
    "is_buyout_possible": false
}

Name

Description

is_buyout_possible*

Type: boolean

Возможен ли выкуп авто

minimum_period_days*

Type: integer

Минимальный срок аренды

Min value: 1

name*

Type: string

Название условия аренды

Min length: 1

Max length: 500

rent_term_id*

Type: string

Идентификатор условия аренды

schemas*

Type: RentSchemeDto[]

Cхемы аренды
Схема аренды

Min items: 1

deposit_amount_daily

Type: string

Ставка депозита в день

Example: 50.1200

deposit_amount_total

Type: string

Полная сумма депозита за аренду авто

Example: 50.1200

RentSchemeDto

Схема аренды

Name

Description

daily_amount*

Type: string

Стоимость аренды в день

Example: 50.1200

non_working_days*

Type: integer

Количество дней в которые авто не сдается в аренду

Min value: 0

working_days*

Type: integer

Количество дней в которые авто сдается в аренду

Min value: 1

Responses

200 OK

Создание или изменение условия аренды

Body

application/json
{
    "rent_term_id": "string",
    "name": "string"
}

Name

Description

name*

Type: string

Название условия аренды

Min length: 1

Max length: 500

rent_term_id*

Type: string

Идентификатор условия аренды

400 Bad Request

Некорректные параметры запроса. Возможные коды ошибок:

  • name_already_exists - Условие аренды с таким названием уже существует
  • deposit_amount_total_less_than_deposit_amount_daily - Cтавка депозита должна быть меньше суммы депозита
  • deposit_amount_total_not_specified - Не указана сумма депозита при указанной ставке депозита
  • duplicated_schemas - Дублируются пара (working_days,non_working_days) в схеме аренды
  • scheme_daily_amount_less_or_equal_zero - Cтоимость аренды меньше или равна нулю
  • number_of_schemas_with_zero_non_working_days_exceeded - Количество схем с нулевым не рабочими днями больше одного
  • number_of_schemas_exceeded - Количество схем больше чем 10

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

404 Not Found

Запрашиваемый ресурс не найден

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки