Список договоров аренды
Этот API передаёт информацию о договорах аренды из модуля Rent Car (AVIS): открытые, забронированные и закрытые договоры. Для каждого договора возвращаются данные об арендаторе, точках начала и окончания аренды, плановых датах выдачи и возврата, а также номера договоров и автомобиля.
Как получить данные
Метод
GET
Адрес запроса
Для получения данных используйте адрес: https://<server_address>/api/api.php?
Параметры запроса
Чтобы получить нужные данные, добавьте к адресу запроса следующие параметры:
-
cmd=rentcar_contracts — команда для получения списка договоров аренды.
-
status — статус договоров, которые нужно получить. Можно передать один статус или несколько через запятую:
-
open — открытые договоры (аренда сейчас активна)
-
booked — забронированные договоры (бронь, аренда ещё не началась)
-
closed — закрытые договоры (аренда завершена)
Формат запрашиваемых данных — массив договоров аренды.
Пример запроса
https://<server_address>/api/api.php?cmd=rentcar_contracts&status=open,booked,closed
|
Ответ
{
"code": 0,
"msg": "OK",
"list": [
{
"driver_name": "Тестовый арендатор",
"driver_phone": "905074521698",
"end_location": {
"title": "Dubai"
},
"start_location": {
"title": "Dubai"
},
"mva": "12312",
"ra": "16",
"te_expected": 1775901540,
"ts_expected": 1775812680,
"plate_number": "Private house"
},
{
"driver_name": "Тестовый арендатор",
"driver_phone": "905074521698",
"end_location": {
"title": "rgergrr"
},
"start_location": {
"title": "erterter"
},
"mva": "2222",
"ra": "17",
"te_expected": 1775901540,
"ts_expected": 1775812680,
"plate_number": "ABC-123"
}
]
}
|
В ответ на API-запрос возвращается:
-
code — код статуса (0 — успех)
-
msg — сообщение о статусе (OK — запрос выполнен успешно)
-
list — массив договоров аренды, каждый из которых содержит:
-
driver_name — имя арендатора (водителя), на которого оформлен договор
-
driver_phone — контактный телефон арендатора
-
start_location — точка начала аренды (выдача автомобиля):
-
title — название/адрес точки выдачи
-
end_location — точка окончания аренды (возврат автомобиля):
-
title — название/адрес точки возврата
-
mva — номер договора аренды (Master Vehicle Agreement)
-
ra — номер бронирования / соглашения об аренде (Rental Agreement)
-
ts_expected — плановое время начала аренды (Unix timestamp)
-
te_expected — плановое время окончания аренды (Unix timestamp)
-
plate_number — государственный регистрационный номер автомобиля по договору