Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 34
Next »
Method parameters
Name | Type | Description |
---|
There are no method parameters in this resource |
Query parameters
Name | Type | Description |
---|
token | xsd:string | REQUIRED. More information concerning authorization in API introduction section
|
lang | xsd:string | Determines language for the output data. The complete list of possible languages can be retrieved using the API resource: languages.index
|
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 |
stage_id | xsd:int | REQUIRED. Identifier of the stage related to the group. The complete list of possible stages can be retrieved using the API resource: stages.index |
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
Output elements
competition |
id | Unique identifier for the competition | ls_id | For internal purposes | name | Name of the the competition e.g. U19 World Champ. Possible translation of the attribute | source | For internal purposes | source_dc | For internal purposes | source_super | For internal purposes | short_name | Abbreviated name of the competition e.g. U19 WCH, Max 20 characters. Possible translation of the attribute | mini_name | Mini name of the competition. Max 3 characters in length e.g. U19 | gender | Competition gender. Possible values: | type | Competitions type. Possible values: - country_league - e.g Premier Division
- country_cups - e.g. FA Cup
- international - e.g. World Cup
- international_clubs - e.g. Champions League
- friendly - friendly matches
- individual - for speedway individual competitions such as Speedway GP
- team - for speedway national competitions
- single - for tennis competitions
- double - for tennis competitions
- mixed - for tennis competitions
- undefined - other
| area_id | Unique identifier for area in which competitions are played. The complete list of possible areas can be retrieved using the API resource: areas.index | area_name | Name of area in which competitions are played. Possible translation of the attribute | area_type | Type of area in which competitions are played. Possible values: | area_sort | The parameter used to sort competitions in a country e.g. Premier League is 1st and the Championship is 2nd in English competitions. Sorting direction is ascending | area_code | Max 3 characters, area in which competitions are played | overall_sort | The parameter used to sort competitions. Sorting direction is ascending | sport_id | Unique identifier for the sport in which the competition is played. The complete list of possible sports can be retrieved using the API resource: sports.index | sport_name | Name of the sport in which the competition is played. Possible translation of the attribute | tour_id | Unique identifier for the tour in which thecompetition is played. The complete list of possible tours can be retrieved using the API resource: tours.index | tour_name | Name of the tour in which the competition is played | ut | Information about when the date and time of the competition record was last updated. Format UNIX_TIMESTAMP | old_competition_id | DEPRECATED. The attribute will be removed in the next API version | slug | friendly url for competition | status | Possible values: - active
- inactive
- archived (for competitions that no longer take place)
|
|
competitions > competition > seasons |
|
---|
id | Unique identifier for the season. | name | Name of the season e.g. Premiership 2014/15 | year | Determines the season year e.g. - 1970
- 1970/71
- 1971
- 1971/72
- 2000
- 2000/01
- 2014
- 2014/15
| actual | Determines if the season is actual. Possible values: | ut | Information about the date and time of when the season record was last updated. Format UNIX_TIMESTAMP | old_season_id | deprecated. The attribute will be removed in the next API version | stats_lvl | Season's stats level. Possible values: vip, gold, silver, bronze | team_connection | For internal usage |
|
competition > season > stage |
---|
|
|
---|
|
---|
id | Unique identifier for the group | name | Name of the group | ut | Information about the date and time of when the group record was last updated. Format UNIX_TIMESTAMP |
|