Booking Cars API

GET | /positions

Метод для получения списка всех должностей

get параметры:

• name - фильтрация по названию должности
• count-items - настройка количества элементов на странице

POST | /positions

Метод для добавления новой должности

Headers

Accept: application/json
Content-Type: application/json

Тело запроса:

{
    "name": "string|max 255"
}

PATCH | /positions//attach-comfort-categories

Метод для закрепления категорий комфорта к должности

Headers

Accept: application/json
Content-Type: application/json

get params:

position - id должности

{
    "comfortCategories": [
        1, 2, 3 // integer | exists ids comfort category
    ]
}

PATCH | /positions//detach-comfort-categories

Метод для открепления категорий комфорта к должности

Headers

Accept: application/json
Content-Type: application/json

get params:

position - id должности

{
    "comfortCategories": [
        1, 2, 3 // integer | exists ids comfort category
    ]
}

GET | /comfort-categories

Метод для получения списка категорий комфорта

get параметры:

• name - фильтрация по названию категории комфорта
• count-items - настройка количества элементов на странице

POST | /comfort-categories

Метод для создания категории комфорта

Headers

Accept: application/json
Content-Type: application/json

Тело запроса

{
    "name": "required|max:255",
    "description": "nullable|max:10000"
}

GET | /employees

Метод для получения списка сотрудников

get параметры:

• name - фильтрация по имени сотрудника
• count-items - настройка количества элементов на странице

POST | /employees

Метод для добавления нового сотрудника

Headers

Accept: application/json
Content-Type: application/json

Тело запроса:

{
    "full_name": "required|max:255",
    "position_id": "required|exists:positions,id"
}

GET | /employees//trips

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

get параметры:

• status - этот параметр принимает два значения (open, closed) соответственно open указывает поездка будет в будущем, closed указывает что поездка состоялась и поле в finished_at было установлено дата окончание поездки
• comfort-categories - принимает айдишники категорий комфорта машин для фильтрации
• started - фильтрация по диапазону началу поездки(started_at), указывается стартовая дата (started[from]) и конец даты (started[to]), при указании started[from] будет фильтрация по этой дате
• car-types - принимает тип машин (SEDAN, COMPARTMENT, UNIVERSAL, HATCHBACK, OFF_ROAD_VEHICLE, CROSSOVER, PICKUP_TRUCK, MINIVAN)
• name-car - фильтрация по названию машины

GET | /cars

Метод получения списка машин

get параметры:

• name - фильтрация по названию машины
• count-items - настройка количества элементов на странице

POST | /cars

Метод добавления машины

Headers

Accept: application/json
Content-Type: application/json

Тело запроса:

{
    "name": "required|max:255",
    "type": "required|in:SEDAN, COMPARTMENT, UNIVERSAL, HATCHBACK, OFF_ROAD_VEHICLE, CROSSOVER, PICKUP_TRUCK, MINIVAN",
    "driver_id": "required|exists:employees,id",
    "comfort_category_id": "required|exists:comfort_categories,id"
}

GET | /trips

Метод для получения списка поездок

get параметры:

• name - фильтрация по названию поездки
• count-items - настройка количества элементов на странице

POST | /trips

Метод для добавления новой поездки

Headers

Accept: application/json
Content-Type: application/json

Тело запроса:

{
    "name": "required|max:255",
    "description": "nullable|max:10000",
    "employee_id": "required|exists:employees,id",
    "car_id": "required|exists:cars,id",
    "started_at": "nullable|date"
}