(Quick Reference)
22 Serial numbers - Reference Documentation
Version: 2.1
22 Serial numbers
22.1 List
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."
}22.2 Show
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."
}22.3 Create
Service: Create a serial number
Description: Returns the created serial number in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/serialNumbers
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| value | | String | Required if single save | |
| itemId | | Long/String | yes | |
| values | list of unique serial numbers values | JSON list | Required if multiple save | ["7B341","4F1AE2"] |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output (single save)
Status: HTTP/1.1 201 Created
{
"id": 2704566,
"value": "74924P109E",
"status": "NEW",
"itemId": 771,
"item": {
"id": 771,
"reference": "LENOVO-A7010-WHITE",
"href": "/api/v1.0/items/771"
},
"organization": "entity1",
"dateCreated": "2016-11-08T08:25:05Z",
"lastUpdated": "2016-11-08T08:25:05Z"
}Success Output (multiple save)
Status: HTTP/1.1 201 Created
{
"data": [
{
"id": 2704620,
"value": "4F1341",
"status": "NEW",
"itemId": 785,
"item": {
"id": 785,
"reference": "eliteBook_revolve_810",
"href": "/api/v1.0/items/785"
},
"warehouseStockId": null,
"organization": "entity1",
"dateCreated": "2016-11-08T15:19:35Z",
"lastUpdated": "2016-11-08T15:19:35Z"
},
{
"id": 2704621,
"value": "7BAE2",
"status": "NEW",
"itemId": 785,
"item": {
"id": 785,
"reference": "eliteBook_revolve_810",
"href": "/api/v1.0/items/785"
},
"warehouseStockId": null,
"organization": "entity1",
"dateCreated": "2016-11-08T15:19:35Z",
"lastUpdated": "2016-11-08T15:19:35Z"
}
]
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "invalid_param_type",
"error_description": "The type of parameter itemId you provided is not valid for this request."
}{
"error": "not_unique",
"error_description": "value already used"
}{
"error": "not_unique",
"error_description": "Serial number must be unique"
}{
"error": "not_unique",
"error_description": "serial number value already used"
}Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The item with the id 77 doesn't exist."
}22.4 Update
Service: Update a serial number
Description: Returns the updated 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}: PUT
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired serial number | Long/String | yes | 123 |
| value | | String | yes | |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output
Status: HTTP/1.1 200 OK
{
"id": 2704563,
"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-08T08:15:34Z",
"lastUpdated": "2016-11-08T08:15:34Z"
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "not_unique",
"error_description": "value already used"
}{
"error": "not_unique",
"error_description": "Serial number must be unique"
}{
"error": "not_unique",
"error_description": "serial number value already used"
}Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The serial number with the id 89 doesn't exist."
}{
"error": "not_found",
"error_description": "The item with the id 77 doesn't exist."
}22.5 Delete
Service: Delete a serial number
Description: Returns a json response.
URL:
https://BASE_URL/api/VERSION/serialNumbers/{id}: DELETE
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
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The serial number with the id 706 doesn't exist."
}
