(Quick Reference)
Service: Show a region
Description: This web service return an existing region data of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/regions/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired region | Long | Yes | 777 |
Success Output
Success case: response.status = 200
{
"id": 3,
"name": "Nice",
"parentId": 1,
"position": 1,
"dateCreated": "2016-09-19T07:52:46Z",
"lastUpdated": "2016-09-19T07:52:46Z"
} 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 region with the id 999 doesn't exist."
}
