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

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-ключ Min length: `1` Example: `<API-ключ>`
X-Client-ID	Type: string Идентификатор клиента Min length: `1` Example: `<Идентификатор клиента>`
X-Idempotency-Token	Type: string Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов Min length: `16` Max length: `64` Example: `c56fa6537e5a4adbbce6ef3593210fb9`
X-Park-ID	Type: string Идентификатор партнера Example: `ee6f33c4562b4e1f8646d157bd70b2c4`

Body

application/json

{
  "rent_term_id": "example",
  "name": "example",
  "schemas": [
    {
      "working_days": 1,
      "non_working_days": 0,
      "daily_amount": "50.1200"
    }
  ],
  "minimum_period_days": 1,
  "deposit_amount_total": null,
  "deposit_amount_daily": null,
  "is_buyout_possible": true
}

Name	Description
is_buyout_possible	Type: IsBuyoutPossible Возможен ли выкуп авто Example: `true`
minimum_period_days	Type: MinimumPeriodDays Минимальный срок аренды Min value: `1` Example: `1`
name	Type: RentTermName Название условия аренды Min length: `1` Max length: `500` Example: `example`
rent_term_id	Type: RentTermId Идентификатор условия аренды Example: `example`
schemas	Type: RentSchemeDto[] Cхемы аренды Min items: `1` Example `[ { "working_days": 1, "non_working_days": 0, "daily_amount": "50.1200" } ]`
deposit_amount_daily	Type: DepositAmountDaily Ставка депозита в день Число с 4 запятыми после запятой Example: `50.1200`
deposit_amount_total	Type: DepositAmountTotal Полная сумма депозита за аренду авто Число с 4 запятыми после запятой Example: `50.1200`

RentTermId

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

Type: string

Example: example

RentTermName

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

Type: string

Min length: 1

Max length: 500

Example: example

WorkingDays

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

Type: integer

Min value: 1

NonWorkingDays

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

Type: integer

Min value: 0

Decimal

Число с 4 запятыми после запятой

Type: string

Example: 50.1200

DailyAmount

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

Число с 4 запятыми после запятой

Type: Decimal

Example: 50.1200

RentSchemeDto

Схема аренды

Name	Description
daily_amount	Type: DailyAmount Стоимость аренды в день Число с 4 запятыми после запятой Example: `50.1200`
non_working_days	Type: NonWorkingDays Количество дней в которые авто не сдается в аренду Min value: `0` Example: `0`
working_days	Type: WorkingDays Количество дней в которые авто сдается в аренду Min value: `1` Example: `1`

Example

{
  "working_days": 1,
  "non_working_days": 0,
  "daily_amount": "50.1200"
}

MinimumPeriodDays

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

Type: integer

Min value: 1

DepositAmountTotal

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

Число с 4 запятыми после запятой

Type: Decimal

Example: 50.1200

DepositAmountDaily

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

Число с 4 запятыми после запятой

Type: Decimal

Example: 50.1200

IsBuyoutPossible

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

Type: boolean

Responses

200 OK

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

Body

application/json

{
  "rent_term_id": "example",
  "name": "example"
}

Name

Description

name

Type: RentTermName

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

Min length: 1

Max length: 500

Example: example

rent_term_id

Type: RentTermId

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

Example: example

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": "example",
  "message": "Текстовое описание ошибки"
}

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

401 Unauthorized

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

403 Forbidden

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

404 Not Found

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

429 Too Many Requests

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

500 Internal Server Error

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

Была ли статья полезна?

Изменить привязанное к авто условие аренды

Отвязка автомобиля от водителя (курьера)