(Quick Reference)
Service: Show a loading detail
Description: Returns the requested loading detail in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/loadingDetails/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired payment type | Long | yes | 123 |
Success Output
Status: HTTP/1.1 200 OK
{
"id": 1,
"loadingReference": "ref-2015-12-17",
"loading": {
"id": 1,
"reference": "ref-2015-12-17",
"href": "/api/v1.0/loadings/1"
},
"itemReference": "bracelet-GRP09062",
"unitReference": "pcs",
"item": {
"id": 495,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"href": "/api/v1.0/items/495"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"quantity": 600,
"organization": "entity1",
"dateCreated": "2015-12-17T08:21:13Z",
"lastUpdated": "2015-12-17T08:21:13Z"
} Failure Output
Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The loading detail with the id 1599 doesn't exist."
}Status: HTTP/1.1 400 Bad Request
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
