Skip to content

03. Administrator API endpoints

Sergei Tarasov edited this page Apr 2, 2023 · 1 revision

Breed Controller

readAll

Возвращает все породы из базы данных.

HTTP method - GET /breed

readById

Возвращает породу по заданному идентификатору из базы данных.

HTTP method - GET /breed/{id}

create

Создает новую породу в базе данных.

HTTP method - POST /breed

edit

Обновляет данные о существующей породе в базе данных или показывает статус "NOT_FOUND", если порода не найдена по заданному идентификатору.

HTTP method - PUT /breed

delete

Удаляет информацию о породе из базы данных или показывает статус "NOT_FOUND", если порода не найдена по заданному идентификатору.

HTTP method - DELETE /breed/{id}

Customer Controller

getAllCustomers

Возвращает всех усыновителей из базы данных.

HTTP method - GET /customer

getCustomerById

Возвращает усыновителя по заданному идентификатору из базы данных.

HTTP method - GET /customer/{id}

createCustomer

Создает нового усыновителя в базе данных.

HTTP method - POST /customer

updateCustomer

Обновляет данные о существующем усыновителе в базе данных или показывает статус "NOT_FOUND", если усыновитель не найден по заданному идентификатору.

HTTP method - PUT /customer

removeCustomer

Удаляет информацию об усыновителе из базы данных или показывает статус "NOT_FOUND", если усыновитель не найден по заданному идентификатору.

HTTP method - DELETE /customer/{id}

getCustomerListWithoutTodayReport

Возвращает список Пользователей, которые должны сегодня сдать отчет, но еще его не сдали.

HTTP method - GET /customer/whithout-report

Info Controller

getAllInfoRecords

Возвращает все записи.

HTTP method - GET /info

getInfoById

Возвращает запись по заданному идентификатору.

HTTP method - GET /info/{id}

createInfo

Создает новую запись.

HTTP method - POST /info

updateInfo

Обновляет данные о существующей записи или показывает статус "NOT_FOUND", если запись не найдена по заданному идентификатору.

HTTP method - PUT /info

removeInfo

Удаляет запись или показывает статус "NOT_FOUND", если запись не найдена по заданному идентификатору.

HTTP method - DELETE /info/{id}

Pet Controller

readAll

Возвращает всех питомцев из базы данных.

HTTP method - GET /pet

readPetById

Возвращает питомца по заданному идентификатору из базы данных.

HTTP method - GET /pet/{id}

createPet

Создает нового питомца в базе данных.

HTTP method - POST /pet

updatePet

Обновляет данные о существующем питомце в базе данных или показывает статус "NOT_FOUND", если питомец не найден по заданному идентификатору.

HTTP method - PUT /pet/{id}

deletePet

Удаляет информацию о питомце из базы данных или показывает статус "NOT_FOUND", если питомец не найден по заданному идентификатору.

HTTP method - DELETE /pet/{id}

setCustomerForPet

Добавляет в запись о питомце идентификатор пользователя, который этого питомца усыновил.

HTTP method - PUT /pet/{pet-id}/customer/{customer-id}

Report Controller

findAllReport

Возвращает все отчёты из базы данных.

HTTP method - GET /report

findReportById

Возвращает отчёт по заданному идентификатору из базы данных.

HTTP method - GET /report/{id}

deleteReport

Удаляет информацию об отчёте из базы данных или показывает статус "NOT_FOUND", если отчёт не найден по заданному идентификатору.

HTTP method - DELETE /report/{id}

updateReport

Обновляет существующий отчёт в базе данных или показывает статус "NOT_FOUND", если отчёт не найден по заданному идентификатору.

HTTP method - PUT /report/{id}

createReport

Создает новый отчёт в базе данных.

HTTP method - POST /report

getPhotosByReportId

Возвращает список фотографий относящихся к отчету с идентификатором ID

HTTP method - GET /report/{id}/photos

previewPhotoById

Отображает фотографию найденную по photoId

Shelter Controller

findAll

Возвращает все приюты из базы данных.

HTTP method - GET /shelter

findById

Возвращает приют по заданному идентификатору из базы данных.

HTTP method - GET /shelter/{id}

create

Создает новый приют в базе данных.

HTTP method - POST /shelter

edit

Обновляет данные о существующем приюте в базе данных или показывает статус "NOT_FOUND", если приют не найден по заданному идентификатору.

HTTP method - PUT /shelter

delete

Удаляет информацию о приюте из базы данных или показывает статус "NOT_FOUND", если приют не найден по заданному идентификатору.

HTTP method - DELETE /shelter/{id}

Volunteer Controller

findAllVolunteers

Возвращает всех волонтёров из базы данных.

HTTP method - GET /volunteer

findVolunteerById

Возвращает волонтёра по заданному идентификатору из базы данных.

HTTP method - GET /volunteer/{id}

createVolunteer

Создает нового волонтёра в базе данных.

HTTP method - POST /volunteer

updateVolunteer

Обновляет данные о существующем волонтёре в базе данных или показывает статус "NOT_FOUND", если волонтёр не найден по заданному идентификатору.

HTTP method - PUT /volunteer

deleteVolunteer

Удаляет информацию о волонтёр из базы данных или показывает статус "NOT_FOUND", если волонтёр не найден по заданному идентификатору.

HTTP method - DELETE /volunteer/{id}