(Quick Reference)
Service: List serial numbers
Description: This web service returns a json list of serial numbers.
URL:
https://BASE_URL/api/VERSION/serialNumbers
: 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 | |
| itemReference | Wildcard search by the related item's reference | String | no | itemReference=ref-6* , itemReference=*ef-6 , itemReference=*ef-6* |
| value | Wildcard search by the serial number's value | String | no | |
| status | Search by the serial number's status | String | no | reserved, new, sold |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Status: HTTP/1.1 200 OK
{
"paging": {
"total": 1078,
"max": 1,
"offset": 0,
"previous": null,
"next": "/api/v1.0/serialNumbers?max=1&offset=1&sort=dateCreated&order=asc"
},
"data": [
{
"id": 1,
"value": "74924P109E",
"status": "SOLD",
"itemId": 765,
"item": {
"id": 765,
"reference": "HUAWEI-Y6-PRO-BLACK",
"href": "/api/v1.0/items/765"
},
"warehouseStockId": null,
"organization": "entity1",
"dateCreated": "2016-10-20T23:00:00Z",
"lastUpdated": "2016-11-07T13:35:01Z"
}
]
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}
