(Quick Reference)
72 Appointments - Reference Documentation
Version: 2.1
72 Appointments
72.1 List
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..."
}72.2 Show
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."
}72.3 Save
Service: Create an appointment Description: This web service is used to add a new appointment object to the database URL: https://BASE_URL/api/VERSION/appointments : POST Request content type: application/json Parameters: | Name | Description | Type | Required | Example values |
|---|
| reference | the reference of the new appointment | String | Yes | | | title | | String | yes | | | startDate | | String | yes | 2016-10-09T08:10:00Z | | endDate | | String | yes | 2016-11-09T08:10:00Z | | note | | String | no | | | appointmentCategoryId | | Integer/String | yes | 123 | | done | | Boolean | no | true , false | | customerId | | Long/String | no | | | contacts | list of contacts id of specified customer to be assigned to the appointment | List | no | [1,2,3,4] , [1] | | useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output Success case: response.status = 201
{
"id": 132,
"reference": "ref-01",
"title": "Check the rest",
"note": "checking if the rest of merchandise is transfered",
"startDate": "2016-10-12T09:20:00Z",
"endDate": "2016-10-12T09:25:00Z",
"done": true,
"user": {
"id": 4,
"reference": "emp-00",
"href": "/api/v1.0/users/4"
},
"customerId": 3230,
"customer": {
"id": 3230,
"reference": "960",
"name": "Flipopia",
"href": "/api/v1.0/customers/3230"
},
"appointmentCategoryId": 1,
"appointmentCategory": {
"id": 1,
"reference": "meeting",
"name": "Rendez-vous",
"href": "/api/v1.0/appointmentCategories/1"
},
"contacts": [
{
"id": 9,
"href": "/api/v1.0/contacts/9"
},
{
"id": 8,
"href": "/api/v1.0/contacts/8"
}
],
"organization": "entity1",
"dateCreated": "2016-10-12T11:28:34Z",
"lastUpdated": "2016-10-12T11:28:34Z"
} Failure Output Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "title parameter is missing"
}{
"error": "date_validation_error",
"error_description": "Failed to add the appointment with the reference -: startDate incorrect Date Format"
}{
"error": "invalid_param_type",
"error_description": "The type of parameter appointmentCategoryId you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}{
"error": "not_found",
"error_description": "The customer with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}72.4 Update
Service: Update an appointment Description: This web service is used to add a new appointment object to the database URL: https://BASE_URL/api/VERSION/appointments/{id}: https://BASE_URL/api/VERSION/appointments/reference/{id}: PUT Request content type: application/json Parameters: | Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to update | Long/String | yes | 777 | | reference | the reference of the appointment | String | Yes | | | title | | String | yes | | | startDate | | String | yes | 2016-10-09T08:10:00Z | | endDate | | String | yes | 2016-11-09T08:10:00Z | | note | | String | no | | | appointmentCategoryId | | Integer/String | yes | 123 | | done | | Boolean | no | true , false | | customerId | | Long/String | no | | | contacts | list of contacts id of specified customer to be assigned to the appointment | List | no | [1,2,3,4] , [1] |
Success Output Success case: response.status = 20
{
"id": 132,
"reference": "ref-01",
"title": "Check the rest",
"note": "checking if the rest of merchandise is transfered",
"startDate": "2016-10-12T09:20:00Z",
"endDate": "2016-10-12T09:25:00Z",
"done": true,
"user": {
"id": 4,
"reference": "emp-00",
"href": "/api/v1.0/users/4"
},
"customerId": 3230,
"customer": {
"id": 3230,
"reference": "960",
"name": "Flipopia",
"href": "/api/v1.0/customers/3230"
},
"appointmentCategoryId": 1,
"appointmentCategory": {
"id": 1,
"reference": "meeting",
"name": "Rendez-vous",
"href": "/api/v1.0/appointmentCategories/1"
},
"contacts": [
{²
"id": 9,
"href": "/api/v1.0/contacts/9"
},
{
"id": 8,
"href": "/api/v1.0/contacts/8"
}
],
"organization": "entity1",
"dateCreated": "2016-10-12T11:28:34Z",
"lastUpdated": "2016-10-12T11:28:34Z"
} Failure Output Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "title parameter is missing"
}{
"error": "date_validation_error",
"error_description": "Failed to add the appointment with the reference -: startDate incorrect Date Format"
}{
"error": "invalid_param_type",
"error_description": "The type of parameter appointmentCategoryId you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}{
"error": "not_found",
"error_description": "The customer with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}72.5 Upsert
Service: Upsert an appointment Description: This web service is used to insert an appointment object to the database if it does not already exist, or update it. URL with external_id: https://BASE_URL/api/VERSION/appointments/reference/{id}: POST Request content type: application/json Parameters: | Name | Description | Type | Required | Example values |
|---|
| title | | String | yes | | | startDate | | String | yes | 2016-10-09T08:10:00Z | | endDate | | String | yes | 2016-11-09T08:10:00Z | | note | | String | no | | | appointmentCategoryId | | String | yes | 123 | | done | | Boolean | no | true , false | | customerId | | String | no | | | contacts | list of contacts id of specified customer to be assigned to the appointment | List | no | [1,2,3,4] , [1] |
Success Output Success case: response.status = 201
{
"id": 132,
"reference": "ref-01",
"title": "Check the rest",
"note": "checking if the rest of merchandise is transfered",
"startDate": "2016-10-12T09:20:00Z",
"endDate": "2016-10-12T09:25:00Z",
"done": true,
"user": {
"id": 4,
"reference": "emp-00",
"href": "/api/v1.0/users/4"
},
"customerId": 3230,
"customer": {
"id": 3230,
"reference": "960",
"name": "Flipopia",
"href": "/api/v1.0/customers/3230"
},
"appointmentCategoryId": 1,
"appointmentCategory": {
"id": 1,
"reference": "meeting",
"name": "Rendez-vous",
"href": "/api/v1.0/appointmentCategories/1"
},
"contacts": [
{
"id": 9,
"href": "/api/v1.0/contacts/9"
},
{
"id": 8,
"href": "/api/v1.0/contacts/8"
}
],
"organization": "entity1",
"dateCreated": "2016-10-12T11:28:34Z",
"lastUpdated": "2016-10-12T11:28:34Z"
} Failure Output Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "title parameter is missing"
}{
"error": "date_validation_error",
"error_description": "Failed to add the appointment with the reference -: startDate incorrect Date Format"
}{
"error": "invalid_param_type",
"error_description": "The type of parameter appointmentCategoryId you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}{
"error": "not_found",
"error_description": "The customer with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}72.6 Delete
Service: Delete an appointment Description: Returns a json response. URL: https://BASE_URL/api/VERSION/appointments/{id}: https://BASE_URL/api/VERSION/appointments/reference/{id}: DELETE Parameters: | Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired appointment | Long/String | yes | 123 |
Success Output Success case: response.status = 200 {
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output Failure case:response.status = 400 {
"error": "delete_failed",
"error_description": "Failed to delete instance."
} Failure case:response.status = 404 {
"error": "not_found",
"error_description": "The appointment with the id 706 doesn't exist."
}
|
|
