(Quick Reference)
Service: Show a serial number
Description: Returns the requested serial number in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/serialNumbers/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired serial number | Long | yes | 123 |
Success Output
Status: HTTP/1.1 200 OK
{
"id": 2704562,
"value": "4562P109E",
"status": "NEW",
"itemId": 771,
"item": {
"id": 771,
"reference": "LENOVO-A7010-WHITE",
"href": "/api/v1.0/items/771"
},
"warehouseStockId": null,
"organization": "entity1",
"dateCreated": "2016-11-07T16:43:45Z",
"lastUpdated": "2016-11-07T16:43:45Z"
} Failure Output
Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The serial number with the id 7065 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."
}
