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 »

Resource information

URLhttps://api.softnetsport.com/v2/groups
MethodGET

Description

Returns a list of all available groups that played in the selected stage
Cache60 seconds
Authorization requiredYes

Method parameters

NameTypeDescription
There are no method parameters in this resource 

Query parameters

NameTypeDescription
tokenxsd:stringREQUIRED. More information concerning authorization in API introduction section
langxsd:string

Determines language for the output data. The complete list of possible languages can be retrieved using the API resource: languages.index

pagexsd:intDetermines offset of paginated data. Default value is 1 which means first page
limitxsd: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_idxsd:intREQUIRED. Identifier of the stage related to the group. The complete list of possible stages can be retrieved using the API resource: stages.index
timestampxsd:unix_timestampSelection 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=74732Returns 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=74732Returns a list of all groups for the selected stage (Group stage in UEFA Champions League) in JSON format

Output elements

competition

idUnique identifier for the competition
ls_idFor internal purposes
nameName of the the competition e.g. U19 World Champ. Possible translation of the attribute
sourceFor internal purposes
source_dcFor internal purposes
source_superFor internal purposes
short_nameAbbreviated 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:

  • male
  • female
  • mixed
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_idUnique identifier for area in which competitions are played. The complete list of possible areas can be retrieved using the API resource: areas.index
area_nameName of area in which competitions are played. Possible translation of the attribute
area_type

 Type of area in which competitions are played. Possible values:

  • country
  • international
area_sortThe 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_codeMax 3 characters, area in which competitions are played
overall_sortThe parameter used to sort competitions. Sorting direction is ascending
sport_idUnique 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_nameName of the sport in which the competition is played. Possible translation of the attribute
tour_idUnique 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_nameName of the tour in which the competition is played
utInformation about when the date and time of the competition record was last updated. Format UNIX_TIMESTAMP
old_competition_idDEPRECATED. The attribute will be removed in the next API version
slugfriendly url for competition
status

Possible values:

  • active
  • inactive
  • archived (for competitions that no longer take place)

competitions > competition > seasons
competition > season

idUnique identifier for the season.
nameName 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:

  • yes
  • no
utInformation about the date and time of when the season record was last updated. Format UNIX_TIMESTAMP
old_season_iddeprecated. The attribute will be removed in the next API version
stats_lvlSeason's stats level. Possible values: vip, gold, silver, bronze
team_connectionFor internal usage

competition > season > stage
idUnique identifier for the stage
stage_name_idUnique identifier for the stage's name.
nameName of the stage. Possible translation of the attribute
start_dateDate when stage begins. Format YYYY-MM-DD
end_dateDate when stage ends. Format YYYY-MM-DD
show_standings

Determines if the stage contains standings. Possible values:

  • yes
  • no
groups_nrThe number of groups that are part of the stage
sortThe sort order for the stage. Sorting direction is ascending
is_current

Possible values:

  • yes
  • no
utInformation about the date and time of when the stage record was last updated. Format UNIX_TIMESTAMP
old_stage_iddeprecated. The attribute will be removed in the next API version
has_brackets

Information about the availability of tournament bracket for the stage. Possible values:

  • yes
  • no
type

Information about the expected Stage type. Possible values:

  • null 

  • bracket type

  • standing type

competition > season > stage > groups
competition > season > stage > groups > group

idUnique identifier for the group
nameName of the group
utInformation about the date and time of when the group record was last updated. Format UNIX_TIMESTAMP


  • No labels