(Quick Reference)
Service: Show a check-in data
Description: This web service return an existing check-in object of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/checkIns/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired check-in | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 8,
"visitRank": 1,
"startDate": "2016-02-20T14:00:00Z",
"endDate": "2016-02-20T14:30:00Z",
"type": "outside",
"latitude": 36.8561473,
"longitude": 10.1953111,
"customerLatitude": 35.83221109,
"customerLongitude": 10.6366781,
"distance": 154876,
"isSure": true,
"editable": true,
"routeId": 1,
"reason": null,
"user": {
"id": 3,
"href": "/api/v1.0/users/3"
},
"customer": {
"id": 2,
"href": "/api/v1.0/customers/2"
},
"organization": "entity1",
"dateCreated": "2016-10-03T15:24:12Z",
"lastUpdated": "2016-10-03T15:24:12Z"
} 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 check-in with the id 5 doesn't exist."
}
