GET api/federations/{federationID}/competitions

Queryable action. Gets the list of competitions for the current season belonging to a federation

Request Information

URI Parameters

NameDescriptionTypeAdditional information
federationID

The unique identifier of the federation to fetch competitions for

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of Competition objects

Collection of Competition
NameDescriptionTypeAdditional information
CompetitionID

The competition's unique identifier

integer

None.

CompetitionTypeID

The type of the competition.Valid CompetitionTypeID'sCompetitionTypeIDDescription1Serie2Cup3Enskilda matcher4Kombinerat5Landskamp

integer

None.

CategoryID

The unique ID of the competition's category. Competitions with the same CategoryID are often related in some way e.g. preliminary round and playoffs in a tournament.

integer

None.

CategoryName

The name of the competition's category

string

None.

Name

The name of the competition

string

None.

ShortName

The short name for the competition if it exists

string

None.

StandingsPublic

Indicates if the standings for the competition is public If the value is false, no data is returned when requests to the standigs action are made.

boolean

None.

ResultsPublic

Indicates if the results for the competition is public If the value is false, no data is returned when requests to the actions involving results and events are made.

boolean

None.

PlayerStatisticsPublic

Indicates if the player statistics for the competition is public. If the value is false, no data is returned when requests to the player statistics action are made.

boolean

None.

GoalieStatisticsPublic

Indicates if the goalie statistics for the competition is public. If the value is false, no data is returned when requests to the goalie statistics action are made.

boolean

None.

SchedulePublic

Indicates if the schedule for the competition is public. If the value is false, no data is returned when requests to the actions involving matches are made.

boolean

None.

NumPromotedTeams

The number of teams promoted to another (higher level) competition

integer

None.

NumDemotedTeams

The number of teams demoted to another (lower level) competition

integer

None.

NumPlayOffTeamsUp

The number of teams qualifying for playoffs for another (higher level) competition

integer

None.

NumPlayOffTeamsDown

The number of teams qualifying for playoffs for another (lower level) competition

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CompetitionID": 1,
    "CompetitionTypeID": 2,
    "CategoryID": 3,
    "CategoryName": "sample string 4",
    "Name": "sample string 5",
    "ShortName": "sample string 6",
    "StandingsPublic": true,
    "ResultsPublic": true,
    "PlayerStatisticsPublic": true,
    "GoalieStatisticsPublic": true,
    "SchedulePublic": true,
    "NumPromotedTeams": 12,
    "NumDemotedTeams": 13,
    "NumPlayOffTeamsUp": 14,
    "NumPlayOffTeamsDown": 15
  },
  {
    "CompetitionID": 1,
    "CompetitionTypeID": 2,
    "CategoryID": 3,
    "CategoryName": "sample string 4",
    "Name": "sample string 5",
    "ShortName": "sample string 6",
    "StandingsPublic": true,
    "ResultsPublic": true,
    "PlayerStatisticsPublic": true,
    "GoalieStatisticsPublic": true,
    "SchedulePublic": true,
    "NumPromotedTeams": 12,
    "NumDemotedTeams": 13,
    "NumPlayOffTeamsUp": 14,
    "NumPlayOffTeamsDown": 15
  }
]

application/xml, text/xml

Sample:
<ArrayOfCompetition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IbisApi.Models">
  <Competition>
    <CategoryID>3</CategoryID>
    <CategoryName>sample string 4</CategoryName>
    <CompetitionID>1</CompetitionID>
    <CompetitionTypeID>2</CompetitionTypeID>
    <GoalieStatisticsPublic>true</GoalieStatisticsPublic>
    <Name>sample string 5</Name>
    <NumDemotedTeams>13</NumDemotedTeams>
    <NumPlayOffTeamsDown>15</NumPlayOffTeamsDown>
    <NumPlayOffTeamsUp>14</NumPlayOffTeamsUp>
    <NumPromotedTeams>12</NumPromotedTeams>
    <PlayerStatisticsPublic>true</PlayerStatisticsPublic>
    <ResultsPublic>true</ResultsPublic>
    <SchedulePublic>true</SchedulePublic>
    <ShortName>sample string 6</ShortName>
    <StandingsPublic>true</StandingsPublic>
  </Competition>
  <Competition>
    <CategoryID>3</CategoryID>
    <CategoryName>sample string 4</CategoryName>
    <CompetitionID>1</CompetitionID>
    <CompetitionTypeID>2</CompetitionTypeID>
    <GoalieStatisticsPublic>true</GoalieStatisticsPublic>
    <Name>sample string 5</Name>
    <NumDemotedTeams>13</NumDemotedTeams>
    <NumPlayOffTeamsDown>15</NumPlayOffTeamsDown>
    <NumPlayOffTeamsUp>14</NumPlayOffTeamsUp>
    <NumPromotedTeams>12</NumPromotedTeams>
    <PlayerStatisticsPublic>true</PlayerStatisticsPublic>
    <ResultsPublic>true</ResultsPublic>
    <SchedulePublic>true</SchedulePublic>
    <ShortName>sample string 6</ShortName>
    <StandingsPublic>true</StandingsPublic>
  </Competition>
</ArrayOfCompetition>