mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-12-25 08:03:01 +03:00
Code Issues Projects Releases Packages Wiki Activity

Correct the example service category requests

Browse source
This commit is contained in:
Alex Tselegidis 2024-07-22 16:54:54 +02:00
parent e89686c6b3
commit 37374a254f
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/rest-api.md
View file

@ -107,10 +107,10 @@ Get the data of a customer with ID 34:
curl http://ea-installation/index.php/api/v1/customers/34 --user username:password curl http://ea-installation/index.php/api/v1/customers/34 --user username:password
``` ```
Update the name of a category with ID 23: Update the name of a service category with ID 23:
``` ```
curl -H 'Content-Type: application/json' -X PUT -d '{"name": "New Name!"}' http://ea-installation/index.php/api/v1/categories/23 --user username:password curl -H 'Content-Type: application/json' -X PUT -d '{"name": "New Name!"}' http://ea-installation/index.php/api/v1/service_categories/23 --user username:password
``` ```
Delete the service with ID 15: Delete the service with ID 15:
@ -225,7 +225,7 @@ You can also try the GET requests with your browser by navigating to the respect
"description": "This is a test service.", "description": "This is a test service.",
"availabilitiesType": "flexible", "availabilitiesType": "flexible",
"attendantsNumber": 1, "attendantsNumber": 1,
"categoryId": null "serviceCategoryId": null
} }
``` ```
@ -236,7 +236,7 @@ You can also try the GET requests with your browser by navigating to the respect
* The `availabilitiesType` must be either `flexible` or `fixed`. * The `availabilitiesType` must be either `flexible` or `fixed`.
### Categories ### Service Categories
**Resource JSON** **Resource JSON**
@ -248,10 +248,10 @@ You can also try the GET requests with your browser by navigating to the respect
} }
``` ```
- `GET /api/v1/categories[/:id]` Get all the categories or a specific one by providing the ID in the URI. - `GET /api/v1/service_categories[/:id]` Get all the service categories or a specific one by providing the ID in the URI.
- `POST /api/v1/categories` Provide the new category JSON in the request body to insert a new record. - `POST /api/v1/service_categories` Provide the new service category JSON in the request body to insert a new record.
- `PUT /api/v1/categories/:id` Provide the updated category JSON in the request body to update an existing record. The ID in the URI is required. - `PUT /api/v1/service_categories/:id` Provide the updated service category JSON in the request body to update an existing record. The ID in the URI is required.
- `DELETE /api/v1/categories/:id` Remove an existing category record. - `DELETE /api/v1/service_categories/:id` Remove an existing service category record.
### Admins ### Admins