-
Notifications
You must be signed in to change notification settings - Fork 1
RESTful services documentation
Yichen Wu edited this page Mar 16, 2021
·
33 revisions
TODO: double-check the outputs!!!
Request type | Endpoints | Method Name | Method Description | Inputs | Outputs |
GET | /appointment/id /appointment/id/ |
getAppointment | get an appointment by ID |
|
|
GET | /appointments/person/id /appointments/person/id/ |
getAppointmentHistory | get all appointments for a given customer |
|
|
PUT | /appointment/id /appointment/id/ |
editAppointment | edit a given appointment |
|
|
DELETE | /appointment/id /appointment/id/ |
deleteAppointment | delete a gievn appointment |
|
|
POST | /appointment /appointment/ |
createAppointment | create a new appointment in the datebase |
|
|
POST | /appointmentNoShow/id /appointmentNoShow/id/ |
enterNoShow | declare no show for a given appointment |
|
|
Request type | Endpoints | Method Name | Method Description | Inputs | Outputs |
GET | /business/id /business/id/ |
getBusiness | get the requested business |
|
|
GET | /business /business/ |
getBusiness | request all business of the entire system | - |
|
POST | /business /business/ |
createBusiness | create new business in the database |
|
|
PUT | /business/id /business/id/ |
updateBusiness | updates business information |
|
|
DELETE | /business/id /business/id/ |
deleteBusiness | deletes the business from the system |
|
|
Request type | Endpoints | Method Description | Inputs |
Florence Yared |
|
23 | |
Himel Saha |
|
23.5 | |
Rakshitha Ravi |
|
18 | |
Saikou Ceesay |
|
24 | |
Yichen Wu |
|
25 |
Request type | Endpoints | Method Name | Method Description | Inputs | Outputs |
GET | /bookableService/name /bookableService/name/ |
getBookableService | get a bookable service by name |
|
|
GET | /bookableServices /bookableServices/ |
getAllBookableServices | get all bookable services in the business | - |
|
PUT | /bookableService/name /bookableService/name/ |
editBookableService | edit a given bookable service |
|
|
DELETE | /bookableService/name /bookableService/name/ |
deleteBookableService | delete a gievn bookable service | @PathVariable("name") String name: the name of the bookable service to be deleted |
|
POST | /bookableService /bookableService/ |
createBookableService | create a new bookable service in the datebase | @RequestBody BookableServiceDto bookableServiceDto:the bookable service that want to be created |
|
Request type | Endpoints | Method Description | Inputs |
Florence Yared |
|
23 | |
Himel Saha |
|
23.5 | |
Rakshitha Ravi |
|
18 | |
Saikou Ceesay |
|
24 | |
Yichen Wu |
|
25 |