(Quick Reference)
Service: List of appointments
Description: This web service returns a json list of appointments.
URL:
https://BASE_URL/api/VERSION/appointments
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The max parameter is set to 100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| startDate_gt | Filters by the resource's startDate date time and operator greater than | Date | no | |
| startDate_gte | Filters by the resource's startDate date time and operator greater than or equal | Date | no | |
| startDate_lt | Filters by the resource's startDate date time and operator less than | Date | no | |
| startDate_lte | Filters by the resource's startDate date time and operator less than or equal | Date | no | |
| endDate_gt | Filters by the resource's endDate date time and operator greater than | Date | no | |
| endDate_gte | Filters by the resource's endDate date time and operator greater than or equal | Date | no | |
| endDate_lt | Filters by the resource's endDate date time and operator less than | Date | no | |
| endDate_lte | Filters by the resource's endDate date time and operator less than or equal | Date | no | |
| title | Wildcard search by the resource's title | String | no | |
| customerReference | Wildcard search by the resource's customer reference | String | no | customerReference=Ref-6* , customerReference=*ef-6 , customerReference=*ef-6* |
| employeeReference | Wildcard search by the resource's employee reference | String | no | employeeReference=Ref-6* , employeeReference=*ef-6 , employeeReference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status = 200
{
"paging": {
"total": 116,
"max": 2,
"offset": 0,
"previous": null,
"next": "/api/v1.0/appointments?max=2&offset=2&sort=dateCreated&order=asc"
},
"data": [
{
"id": 2,
"dateCreated": "2014-09-14T10:20:44Z",
"lastUpdated": "2014-09-14T10:20:44Z",
"title": "Price Negotiation",
"note": null,
"startDate": "2014-09-14T10:20:44Z",
"endDate": "2014-09-14T10:30:44Z",
"done": false,
"customerId": 19,
"customer": {
"id": 19,
"reference": "BATAM",
"name": "Magasin BATAM",
"href": "/api/v1.0/customers/19"
},
"appointmentCategoryId": 3,
"appointmentCategory": {
"id": 3,
"reference": "phone_call",
"name": "Phone call",
"href": "/api/v1.0/appointmentCategories/3"
},
"contacts": []
},
{
"id": 23,
"dateCreated": "2016-10-11T10:06:44Z",
"lastUpdated": "2016-10-11T10:06:44Z",
"title": "Control merchandise",
"note": null,
"startDate": "2016-10-27T05:00:00Z",
"endDate": "2016-10-27T05:00:00Z",
"done": false,
"customerId": null,
"customer": null,
"appointmentCategoryId": 5,
"appointmentCategoryId": 3,
"appointmentCategory": {
"id": 5,
"reference": "other",
"name": "Autre",
"href": "/api/v1.0/appointmentCategories/5"
},
"contacts": []
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
