Countries
About
A country resource identifies a country to which one or more station resources belongs. Below is a JSON representation of a country:
{"name": "A Country", "count": 100}
Properties
A country resource has the following properties:
| Name | Description |
|---|---|
| count | integer The number of stations belonging to the country. |
| name | string The name the country. |
Methods
The API supports the following methods:
| Method | Endpoint | Description |
|---|---|---|
| GET | /countries | Retrieves a list of countries to which one or more stations belong. |
GET /countries
Request
GET http://marxoft.co.uk/api/cuteradio/countries
Parameters
| Name | Description |
|---|---|
| limit | integer The maximum number of results that should be returned. Must be between 1 and 50. The default is 20. |
| offset | integer The index of the first result to be returned. The index is 0-based. |
| search | string The keyword(s) to be used to filter results. |
| sort | string The property used to sort the results. The default is 'name'. |
| sortDescending | boolean Whether result should be sorted in descending order. The default is false. |
Response
{
"items": [
$COUNTRY
],
"next": "/countries?limit=20&offset=20&sort=name&sortDescending=false"
}