(Quick Reference)
Service: Show a reason
Description: This web service return an existing reason of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/reasons/{id}
Method: GET
Parameters:
Name | Description | Type | Required | Example values |
---|
id | The numerical ID of the desired reason | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 2,
"name": "whse transaction",
"type": "3",
"isActive": true,
"organization": "entity1",
"dateCreated": "2016-01-07T10:22:43Z",
"lastUpdated": "2016-01-07T10:22:43Z"
}
Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The reason with the id 10 doesn't exist."
}
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}