Automap — rest — drivers

Водители

Список водителей

GET /drivers

Структура запроса:

GET /drivers?token=bw3ty3h46yth

Параметры фильтрации:

GET /drivers?organizations=1,2,3

Ответ:

Статус: 200 — успешное выполнение

[{
	"id": 1,
	"fio": "Петренко А.П.",
	"phone": "+79172525246",
	"notes": "Опыт вождения более 10 лет",
	"hasPhoto": true,
	"organizationId": 1
},...]

// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// у водителя имеется фото, булевое поле
// id организации, целое число

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Список водителей ТС

GET /cars/{id}/drivers

Структура запроса:

GET /cars/53/drivers?token=bw3ty3h46yth

Ответ:

Статус: 200 — успешное выполнение

[{
		"active": false,
		"driver": {
			"id": 1,
			"fio": "ФИО водителя",
			"phone": "",
			"notes": "Примечание",
			"hasPhoto": false,
			"organizationId": 92
		}
},...]

// активность ТС, булевое поле
// информация о водителе
// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// у водителя имеется фото, булевое поле
// id организации, целое число

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Поиск водителя по id

GET /drivers/{id}

Структура запроса:

GET /drivers/11?token=bw3ty3h46yth

Ответ:

Статус: 200 — успешное выполнение

{
	"id": 20081,
	"fio": "111",
	"phone": "",
	"notes": "",
	"hasPhoto": false,
	"organizationId": 102
}

// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// у водителя имеется фото, булевое поле
// id организации, целое число

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Редактировать информацию о водителе

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

PUT /drivers/{id}

Структура запроса:

PUT /drivers/123?token=bw3ty3h46yth

{
	"fio": "Ренуков Павел Андреевич",
	"hasPhoto": false,
	"id": 20181,
	"notes": "Права категории Б, опыт вождения 8 лет",
	"organizationId": "439",
	"phone": "+79170542871"
}

// ФИО, строка
// есть фото, булева переменная
// id водителя, целое число
// примечание, строка
// id организации, целое число
// телефон, строка

Ответ:

Статус: 200 — успешное выполнение

{
	"id": 20181,
	"fio": "Ренуков Павел Андреевич",
	"phone": "+79170542871",
	"notes": "Права категории Б, опыт вождения 8 лет",
	"hasPhoto": false,
	"organizationId": 439
}

// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// наличие фото, булевое поле
// id организации, целое число

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Создание водителя

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

POST /drivers

Структура запроса:

POST /drivers?token=bw3ty3h46yth

{
	"fio": "Иванченко Артем Сергеевич",
	"notes": "Опыт вождения 4 года",
	"organizationId": "242",
	"phone": "+79655978473"
}

// ФИО, строка
// примечание, строка
// id организации, целое число
// телефон, строка

Ответ:

Статус: 200 — успешное выполнение

{
	"id": 20301,
	"fio": "Иванченко Артем Сергеевич",
	"phone": "+79655978473",
	"notes": "Опыт вождения 4 года",
	"hasPhoto": false,
	"organizationId": 242
}

// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// наличие фото, булевое поле
// id организации, целое число

Статус: 400 — ошибка в запросе

Статус: 500 — ошибка на сервере

Удаление водителя

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

DELETE /drivers/{id}

Структура запроса:

DELETE /drivers/125?token=bw3ty3h46yth

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Выбрать водителей ТС

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

PUT /cars/{id}/drivers/allow

Структура запроса:

PUT /cars/31/drivers/allow?token=bw3ty3h46yth

{
	"drivers": [123,432]
}

// id водителей

Ответ:

Статус: 200 — успешное выполнение

[{
		"active": false,
		"driver": {
			"fio": "Фамилия Имя Отчество",
			"hasPhoto": false,
			"id": 123,
			"notes": "",
			"organizationId": 1,
			"phone": ""
		}
},...]

// состояние активности, булевое поле
// информация о водителе, объект
// ФИО, строка
// наличие фото, булевое поле
// id водителя, целое число
// примечание, строка
// id организации, целое число
// телефон, строка

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Назначить водителя ТС

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

PUT /cars/{id}/drivers/accept

Структура запроса:

PUT /cars/64/drivers/accept?token=bw3ty3h46yth

{
	"driverId": "881"
}

// id водителя, целое число

Ответ:

Статус: 200 — успешное выполнение

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Список водителей в xlsx файле

GET /drivers.xlsx

Структура запроса:

GET /drivers.xlsx?token=bw3ty3h46yth

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Фотография водителя

GET /drivers/{id}/photo

Структура запроса:

GET /drivers/87/photo?token=bw3ty3h46yth

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере