(Quick Reference)
Service: Show an appointment
Description: This web service return an existing appointment object of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/appointments/{id}:
https://BASE_URL/api/VERSION/appointments/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": 5,
"reference": "Ref-01",
"title": "meeting with Mrs. Schrader",
"note": "meeting with Mrs. Schrader at Friday, Nov 27 15:25:00 UTC 2016",
"startDate": "2015-12-27T14:25:00Z",
"endDate": "2015-12-27T14:50:00Z",
"done": true,
"user": {
"id": 1,
"reference": "emp04",
"href": "/api/v1.0/users/1"
},
"customerId": 2,
"customer": {
"id": 2,
"reference": "NC-3",
"name": "Marie's Jewelry",
"href": "/api/v1.0/customers/2"
},
"appointmentCategoryId": 1,
"appointmentCategory": {
"id": 1,
"reference": "meeting",
"name": "Rendez-vous",
"href": "/api/v1.0/appointmentCategories/1"
},
"contacts": [
{
"id": 1,
"href": "/api/v1.0/contacts/1"
}
],
"organization": "entity1",
"dateCreated": "2015-12-15T14:15:02Z",
"lastUpdated": "2016-09-09T17:21:30Z"
} 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 with the id 999 doesn't exist."
}
