(Quick Reference)
Service: Show a report
Description: This web service return a report details of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/reports/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired report | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 2,
"title": "Marie's Jewelry complaint ",
"description": "Late Shipment",
"image": "BASE_URL/entity1-1450169988465/photoNotes/1471338230737_logo_color_272x92dp.png",
"latitude": 35.835454,
"longitude": 10.590584,
"checkInDate": "2015-12-31T15:48:32Z",
"type": "1",
"customerId": 2,
"customer": {
"id": 2,
"reference": "NC-3",
"name": "Marie's Jewelry",
"href": "/api/v1.0/customers/2"
},
"user": {
"id": 2,
"reference": "emp-002",
"href": "/api/v1.0/users/2"
},
"organization": "entity1",
"dateCreated": "2015-12-31T15:48:32Z",
"lastUpdated": "2015-12-31T15:48:32Z"
} 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 report with the id 7 doesn't exist."
}
