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

  1. HTTP-запрос
  2. Заголовки запроса
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 400
    3. Код 401
      1. Представление
      2. Поля
    4. Код 403
      1. Представление
      2. Поля
    5. Код 404
      1. Представление
      2. Поля
    6. Код 429
      1. Представление
      2. Поля
    7. Код 500
      1. Представление
      2. Поля
  5. Пример

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

HTTP-запрос

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

Заголовки запроса

X-Park-ID *

string

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

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

X-Idempotency-Token *

string

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

X-Park-ID *

string

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

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

X-Idempotency-Token *

string

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

Тело запроса

{
  "deposit_amount_daily": "50.1200",
  "deposit_amount_total": "50.1200",
  "is_buyout_possible": false,
  "minimum_period_days": 0,
  "name": "string",
  "rent_term_id": "string",
  "schemas": [
    {
      "daily_amount": "50.1200",
      "non_working_days": 0,
      "working_days": 0
    }
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

deposit_amount_daily

string

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

deposit_amount_total

string

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

is_buyout_possible *

boolean

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

minimum_period_days *

integer

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

Минимальное значение: 1.

name *

string

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

rent_term_id *

string

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

schemas[] *

array

Cхемы аренды

schemas[].daily_amount *

string

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

schemas[].non_working_days *

integer

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

Минимальное значение: 0.

schemas[].working_days *

integer

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

Минимальное значение: 1.

deposit_amount_daily

string

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

deposit_amount_total

string

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

is_buyout_possible *

boolean

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

minimum_period_days *

integer

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

Минимальное значение: 1.

name *

string

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

rent_term_id *

string

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

schemas[] *

array

Cхемы аренды

schemas[].daily_amount *

string

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

schemas[].non_working_days *

integer

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

Минимальное значение: 0.

schemas[].working_days *

integer

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

Минимальное значение: 1.

Ответы

Код 200

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

{
  "name": "string",
  "rent_term_id": "string"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

name *

string

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

rent_term_id *

string

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

name *

string

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

rent_term_id *

string

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

Код 400

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

  • 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

Код 401

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 403

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 404

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 429

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 500

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

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

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Пример

Request:

curl -X PUT "https://fleet-api.taxi.yandex.net/v1/parks/vehicles/rent-terms" \
-H "X-Park-ID: ee6f33c4562b4e1f8646d157bd70b2c4" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>" \
-H "X-Idempotency-Token: c56fa6537e5a4adbbce6ef3593210fb9" \
-d '{
  "deposit_amount_daily": "50.1200",
  "deposit_amount_total": "50.1200",
  "schemas": [
    {
      "daily_amount": "50.1200"
    }
  ]
}'
Скопировано