(Quick Reference)
74 Regions - Reference Documentation
Version: 2.1
74 Regions
74.1 List
Service: List of regions
Description: This web service returns the list of regions in JSON format.
URL:
https://BASE_URL/api/VERSION/regions
: 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 | |
| name | Wildcard search by the resource's name | String | no | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status = 200
{
"paging": {
"total": 3,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"name": "France",
"parentId": null,
"position": null,
"dateCreated": "2016-09-02T08:04:27Z",
"lastUpdated": "2016-09-02T08:04:27Z"
},
{
"id": 2,
"name": "Toulouse",
"parentId": 1,
"position": 0,
"dateCreated": "2016-09-19T07:52:40Z",
"lastUpdated": "2016-09-19T07:52:40Z"
},
{
"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",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}74.2 Show
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."
}
