Resource information
| URL | https://api.softnetsport.com/v2/groups |
|---|---|
| XSD | https://api.softnetsport.com/assets/API/docs/xsd/groups.index.xsd |
| Method | GET |
Description | Returns a list of all available groups that played in the selected stage |
| Cache | 60 seconds |
| Authorization required | Yes |
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
Link | Description |
|---|---|
| https://api.softnetsport.com/v2/groups.xml?token={{YOUR_TOKEN}}&stage_id=74732 | Returns a list of all groups for the selected stage (Group stage in UEFA Champions League) in XML format |
| https://api.softnetsport.com/v2/groups.xml?token={{YOUR_TOKEN}}&stage_id=74732 | Returns a list of all groups for the selected stage (Group stage in UEFA Champions League) in JSON format |
Output elements
.competition | |
|---|---|
| id | Unique identifier for the competition |
| name | Name of the the competition e.g. U19 World Champ |
| short_name | Abbreviated name of the competition e.g. U19 WCH, Max 20 characters |
| 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:
|
| area_id | Unique identifier for the 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 |
| 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 in length for the 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 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 competition is played |
| tour_id | Unique identifier for the tour in which competition 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 competition is played |
| ut | Information about the date and time of when 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 |
| ..seasons | |
..season | |
| id | Unique identifier for the season |
| name | Name of the season e.g. Premiership 2014/15 |
| year | Determines the season year e.g.
|
| 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 |
...stage | |
| id | Unique identifier for the stage. The complete list of possible stages can be retrieved using the API resource: stages.index |
| name | Name of the stage |
| start_date | Date when stage begins. Format YYYY-MM-DD |
| end_date | Date when stage ends. Format YYYY-MM-DD |
| show_standings | Determines if the stage contains standings. Possible values:
|
| groups_nr | The number of groups that are part of the stage |
| sort | The sort order for the stage. Sorting direction is ascending |
| is_current | Possible values:
|
| ut | Information about the date and time of when the stage record was last updated. Format UNIX_TIMESTAMP |
| old_stage_id | deprecated. The attribute will be removed in the next API version |
....groups | |
.....group | |
| 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 |