(Quick Reference)
Service: Show
Description: This web service return an existing customerCategoryDiscountLists of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists/{id}
Parameters:
Name | Description | Type | Required | Example values |
---|
id | id of the desired record | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists/reference/{customerCategoryId}/{discountListId}
Parameters:
Name | Description | Type | Required | Examples values |
---|
customerCategoryId | reference of the customer category | String | Yes | CC-002 |
discountListId | reference of the discount list | String | Yes | DL-001 |
Success Output
Success case: response.status=200
{
"id": 1,
"discountListReference": "RDis-001",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"discountList": {
"id": 4,
"reference": "RDis-001",
"name": "discount1",
"href": "/api/v1/discountLists/4"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T09:55:22Z",
"lastUpdated": "2016-08-24T09:55:22Z"
}
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 customer category discount list with the id 999 doesn't exist."
}