Resource information
| URL | https://api.softnetsport.com/v2/areas |
|---|---|
| XSD | https://api.softnetsport.com/assets/API/docs/xsd/areas.index.xsd |
| Method | GET |
Description | Returns areas used in the API (continents, countries) |
| Cache | 60 seconds |
| Authorization required | No |
Method parameters
| Name | Type | Description |
|---|---|---|
| There are no method parameters in this resource | ||
Query parameters
| Name | Type | Description |
|---|---|---|
| lang | xsd:string | Determines language for the output data |
| page | xsd:int | Determines offset of paginated data. Default value is 1 which means first page |
| limit | xsd:int | Determines maximum number of returned records on page. Used in paginated data. Default value is 500. Possible values: 5, 10, 25, 50, 100, 250, 500 |
| parent_area_id | xsd:int | Identifier which is parent to the selected area |
| timestamp | xsd:unix_timestamp | Selection date, format UNIX_TIMESTAMP. Only changes that occurred or were updated after this timestamp will be returned |
Method calling examples
| Link | Description |
|---|---|
| https://api.softnetsport.com/v2/areas.xml | Returns a list of all areas and sub-areas in XML format |
| https://api.softnetsport.com/v2/areas | Returns a list of all areas and sub-areas in JSON format |
https://api.softnetsport.com/v2/areas.xml?parent_area_id=209 | Returns a list of the areas which are sub-areas of area_id = 209 (Europe) |
Output elements
| . areas | |
|---|---|
| . . area | |
| id | Unique identifier for the area |
| area_code | Three character area code e.g. GER, POL, FRA |
| name | Name of the area. Possible translation of the attribute |
| parent_area_id | Identifier for the parent area e.g. parent area for Poland is Europe and parent area for Europe is World |
| ut | Information about the date and time of when the record was last updated. Format UNIX_TIMESTAMP |