(Quick Reference)
Service: Show an appointment category
Description: This web service return an existing appointment category object of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/appointmentCategories/{id}:
https://BASE_URL/api/VERSION/appointmentCategories/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the wanted record | Long/String | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 1,
"reference": "meeting",
"name": "Rendez-vous",
"isActive": true,
"isDefault": true,
"color": "#FFD312",
"organization": "entity1",
"dateCreated": "2016-09-09T17:18:40Z",
"lastUpdated": "2016-10-12T09:32:18Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The appointment category with the id 999 doesn't exist."
}
