GET api/competitions/{competitionID}/matches

Queryable action. Gets the matches for a competition in IBIS. The results for each match is also fetched when this action is invoked. The events and shots on goal information is NOT fetched when this action is invoked. To get that information call the api/matches/{matchId} action.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
competitionID

The ID of the competition to fetch matches for

integer

Required

Body Parameters

None.

Response Information

Resource Description

A collection of Match objects sorted by Match.Round and Match.MatchDateTime

Collection of Match
NameDescriptionTypeAdditional information
MatchID

The Match's unique identifier

integer

None.

MatchNo

The Match's match number

string

None.

HomeTeamID

The identifier of the home team

integer

None.

HomeTeam

The name of the home team

string

None.

AwayTeamID

The identifier of the away team

integer

None.

AwayTeam

The name of the away team

string

None.

MatchDateTime

The date and time when the match is scheduled

date

None.

Venue

The venue where the match will be played

string

None.

VenueLatitude

The latitude of the venue's position in WGS84 format

decimal number

None.

VenueLongitude

The longitude of the venue's position in WGS84 format

decimal number

None.

Referee1ID

The identifier of referee no 1

integer

None.

Referee1

The name of referee no 1

string

None.

Referee2ID

The identifier of referee no 2

integer

None.

Referee2

The name of referee no 2

string

None.

ShotsOnGoal

The shots on goal statistics for the match. Each item in the list represents the statistics for one period

Collection of ShotsOnGoal

None.

Results

The results for the match

Collection of MatchResult

None.

Spectators

The number of spectators for the match

integer

None.

Events

The list of events for the match

Collection of MatchEvent

None.

Round

The round in the competition's schedule which this match belongs to

integer

None.

RoundName

The name of the round in the competitions's schedule. If the type of the competition is Cup the name is set to "Kvartsfinal", "Semifinal", "1/8-final" etc, otherwise the field is blank.

string

None.

MatchStatus

The current status of the matchValid valuesValueDenotation1Match not started2In progress3Intermission4Match finished

integer

None.

GoalsHomeTeam

The number of goals the home team has scored at the time of the request. (Current standings)

integer

None.

GoalsAwayTeam

The number of goals the away team has scored at the time of the request. (Current standings)

integer

None.

HomeMatchTeamID

The ID of the home match team for the match.

integer

None.

AwayMatchTeamID

The ID of the away match team for the match.

integer

None.

IntermediateResults

The intermediate results for the match (results per period)

Collection of IntermediateResult

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "MatchID": 1,
    "MatchNo": "sample string 2",
    "HomeTeamID": 3,
    "HomeTeam": "sample string 4",
    "AwayTeamID": 5,
    "AwayTeam": "sample string 6",
    "MatchDateTime": "2024-03-29T02:45:15.4060925+01:00",
    "Venue": "sample string 8",
    "VenueLatitude": 9.1,
    "VenueLongitude": 10.1,
    "Referee1ID": 11,
    "Referee1": "sample string 12",
    "Referee2ID": 13,
    "Referee2": "sample string 14",
    "ShotsOnGoal": [
      {
        "Period": 1,
        "ShotsHomeTeam": 2,
        "ShotsAwayTeam": 3
      },
      {
        "Period": 1,
        "ShotsHomeTeam": 2,
        "ShotsAwayTeam": 3
      }
    ],
    "Results": [
      {
        "MatchResultTypeID": 1,
        "MatchResultType": "sample string 2",
        "GoalsHomeTeam": 3,
        "GoalsAwayTeam": 4,
        "IsFinalResult": true,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      },
      {
        "MatchResultTypeID": 1,
        "MatchResultType": "sample string 2",
        "GoalsHomeTeam": 3,
        "GoalsAwayTeam": 4,
        "IsFinalResult": true,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      }
    ],
    "Spectators": 15,
    "Events": [
      {
        "MatchEventID": 1,
        "MatchEventTypeID": 2,
        "MatchEventType": "sample string 3",
        "Period": 4,
        "Minute": 5,
        "Second": 6,
        "PlayerID": 7,
        "PlayerName": "sample string 8",
        "PlayerAssistID": 9,
        "PlayerAssistName": "sample string 10",
        "PenaltyCode": "sample string 11",
        "PenaltyName": "sample string 12",
        "TeamID": 13,
        "TeamName": "sample string 14",
        "GoalsHomeTeam": 15,
        "GoalsAwayTeam": 16,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      },
      {
        "MatchEventID": 1,
        "MatchEventTypeID": 2,
        "MatchEventType": "sample string 3",
        "Period": 4,
        "Minute": 5,
        "Second": 6,
        "PlayerID": 7,
        "PlayerName": "sample string 8",
        "PlayerAssistID": 9,
        "PlayerAssistName": "sample string 10",
        "PenaltyCode": "sample string 11",
        "PenaltyName": "sample string 12",
        "TeamID": 13,
        "TeamName": "sample string 14",
        "GoalsHomeTeam": 15,
        "GoalsAwayTeam": 16,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      }
    ],
    "Round": 16,
    "RoundName": "sample string 17",
    "MatchStatus": 18,
    "GoalsHomeTeam": 19,
    "GoalsAwayTeam": 20,
    "HomeMatchTeamID": 21,
    "AwayMatchTeamID": 22,
    "IntermediateResults": [
      {
        "Period": 1,
        "GoalsHomeTeam": 2,
        "GoalsAwayTeam": 3
      },
      {
        "Period": 1,
        "GoalsHomeTeam": 2,
        "GoalsAwayTeam": 3
      }
    ]
  },
  {
    "MatchID": 1,
    "MatchNo": "sample string 2",
    "HomeTeamID": 3,
    "HomeTeam": "sample string 4",
    "AwayTeamID": 5,
    "AwayTeam": "sample string 6",
    "MatchDateTime": "2024-03-29T02:45:15.4060925+01:00",
    "Venue": "sample string 8",
    "VenueLatitude": 9.1,
    "VenueLongitude": 10.1,
    "Referee1ID": 11,
    "Referee1": "sample string 12",
    "Referee2ID": 13,
    "Referee2": "sample string 14",
    "ShotsOnGoal": [
      {
        "Period": 1,
        "ShotsHomeTeam": 2,
        "ShotsAwayTeam": 3
      },
      {
        "Period": 1,
        "ShotsHomeTeam": 2,
        "ShotsAwayTeam": 3
      }
    ],
    "Results": [
      {
        "MatchResultTypeID": 1,
        "MatchResultType": "sample string 2",
        "GoalsHomeTeam": 3,
        "GoalsAwayTeam": 4,
        "IsFinalResult": true,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      },
      {
        "MatchResultTypeID": 1,
        "MatchResultType": "sample string 2",
        "GoalsHomeTeam": 3,
        "GoalsAwayTeam": 4,
        "IsFinalResult": true,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      }
    ],
    "Spectators": 15,
    "Events": [
      {
        "MatchEventID": 1,
        "MatchEventTypeID": 2,
        "MatchEventType": "sample string 3",
        "Period": 4,
        "Minute": 5,
        "Second": 6,
        "PlayerID": 7,
        "PlayerName": "sample string 8",
        "PlayerAssistID": 9,
        "PlayerAssistName": "sample string 10",
        "PenaltyCode": "sample string 11",
        "PenaltyName": "sample string 12",
        "TeamID": 13,
        "TeamName": "sample string 14",
        "GoalsHomeTeam": 15,
        "GoalsAwayTeam": 16,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      },
      {
        "MatchEventID": 1,
        "MatchEventTypeID": 2,
        "MatchEventType": "sample string 3",
        "Period": 4,
        "Minute": 5,
        "Second": 6,
        "PlayerID": 7,
        "PlayerName": "sample string 8",
        "PlayerAssistID": 9,
        "PlayerAssistName": "sample string 10",
        "PenaltyCode": "sample string 11",
        "PenaltyName": "sample string 12",
        "TeamID": 13,
        "TeamName": "sample string 14",
        "GoalsHomeTeam": 15,
        "GoalsAwayTeam": 16,
        "CreatedTS": "2024-03-29T02:45:15.4060925+01:00"
      }
    ],
    "Round": 16,
    "RoundName": "sample string 17",
    "MatchStatus": 18,
    "GoalsHomeTeam": 19,
    "GoalsAwayTeam": 20,
    "HomeMatchTeamID": 21,
    "AwayMatchTeamID": 22,
    "IntermediateResults": [
      {
        "Period": 1,
        "GoalsHomeTeam": 2,
        "GoalsAwayTeam": 3
      },
      {
        "Period": 1,
        "GoalsHomeTeam": 2,
        "GoalsAwayTeam": 3
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfMatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IbisApi.Models">
  <Match>
    <AwayMatchTeamID>22</AwayMatchTeamID>
    <AwayTeam>sample string 6</AwayTeam>
    <AwayTeamID>5</AwayTeamID>
    <Events>
      <MatchEvent>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>16</GoalsAwayTeam>
        <GoalsHomeTeam>15</GoalsHomeTeam>
        <MatchEventID>1</MatchEventID>
        <MatchEventType>sample string 3</MatchEventType>
        <MatchEventTypeID>2</MatchEventTypeID>
        <Minute>5</Minute>
        <PenaltyCode>sample string 11</PenaltyCode>
        <PenaltyName>sample string 12</PenaltyName>
        <Period>4</Period>
        <PlayerAssistID>9</PlayerAssistID>
        <PlayerAssistName>sample string 10</PlayerAssistName>
        <PlayerID>7</PlayerID>
        <PlayerName>sample string 8</PlayerName>
        <Second>6</Second>
        <TeamID>13</TeamID>
        <TeamName>sample string 14</TeamName>
      </MatchEvent>
      <MatchEvent>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>16</GoalsAwayTeam>
        <GoalsHomeTeam>15</GoalsHomeTeam>
        <MatchEventID>1</MatchEventID>
        <MatchEventType>sample string 3</MatchEventType>
        <MatchEventTypeID>2</MatchEventTypeID>
        <Minute>5</Minute>
        <PenaltyCode>sample string 11</PenaltyCode>
        <PenaltyName>sample string 12</PenaltyName>
        <Period>4</Period>
        <PlayerAssistID>9</PlayerAssistID>
        <PlayerAssistName>sample string 10</PlayerAssistName>
        <PlayerID>7</PlayerID>
        <PlayerName>sample string 8</PlayerName>
        <Second>6</Second>
        <TeamID>13</TeamID>
        <TeamName>sample string 14</TeamName>
      </MatchEvent>
    </Events>
    <GoalsAwayTeam>20</GoalsAwayTeam>
    <GoalsHomeTeam>19</GoalsHomeTeam>
    <HomeMatchTeamID>21</HomeMatchTeamID>
    <HomeTeam>sample string 4</HomeTeam>
    <HomeTeamID>3</HomeTeamID>
    <IntermediateResults>
      <IntermediateResult>
        <GoalsAwayTeam>3</GoalsAwayTeam>
        <GoalsHomeTeam>2</GoalsHomeTeam>
        <Period>1</Period>
      </IntermediateResult>
      <IntermediateResult>
        <GoalsAwayTeam>3</GoalsAwayTeam>
        <GoalsHomeTeam>2</GoalsHomeTeam>
        <Period>1</Period>
      </IntermediateResult>
    </IntermediateResults>
    <MatchDateTime>2024-03-29T02:45:15.4060925+01:00</MatchDateTime>
    <MatchID>1</MatchID>
    <MatchNo>sample string 2</MatchNo>
    <MatchStatus>18</MatchStatus>
    <Referee1>sample string 12</Referee1>
    <Referee1ID>11</Referee1ID>
    <Referee2>sample string 14</Referee2>
    <Referee2ID>13</Referee2ID>
    <Results>
      <MatchResult>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>4</GoalsAwayTeam>
        <GoalsHomeTeam>3</GoalsHomeTeam>
        <IsFinalResult>true</IsFinalResult>
        <MatchResultType>sample string 2</MatchResultType>
        <MatchResultTypeID>1</MatchResultTypeID>
      </MatchResult>
      <MatchResult>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>4</GoalsAwayTeam>
        <GoalsHomeTeam>3</GoalsHomeTeam>
        <IsFinalResult>true</IsFinalResult>
        <MatchResultType>sample string 2</MatchResultType>
        <MatchResultTypeID>1</MatchResultTypeID>
      </MatchResult>
    </Results>
    <Round>16</Round>
    <RoundName>sample string 17</RoundName>
    <ShotsOnGoal>
      <ShotsOnGoal>
        <Period>1</Period>
        <ShotsAwayTeam>3</ShotsAwayTeam>
        <ShotsHomeTeam>2</ShotsHomeTeam>
      </ShotsOnGoal>
      <ShotsOnGoal>
        <Period>1</Period>
        <ShotsAwayTeam>3</ShotsAwayTeam>
        <ShotsHomeTeam>2</ShotsHomeTeam>
      </ShotsOnGoal>
    </ShotsOnGoal>
    <Spectators>15</Spectators>
    <Venue>sample string 8</Venue>
    <VenueLatitude>9.1</VenueLatitude>
    <VenueLongitude>10.1</VenueLongitude>
  </Match>
  <Match>
    <AwayMatchTeamID>22</AwayMatchTeamID>
    <AwayTeam>sample string 6</AwayTeam>
    <AwayTeamID>5</AwayTeamID>
    <Events>
      <MatchEvent>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>16</GoalsAwayTeam>
        <GoalsHomeTeam>15</GoalsHomeTeam>
        <MatchEventID>1</MatchEventID>
        <MatchEventType>sample string 3</MatchEventType>
        <MatchEventTypeID>2</MatchEventTypeID>
        <Minute>5</Minute>
        <PenaltyCode>sample string 11</PenaltyCode>
        <PenaltyName>sample string 12</PenaltyName>
        <Period>4</Period>
        <PlayerAssistID>9</PlayerAssistID>
        <PlayerAssistName>sample string 10</PlayerAssistName>
        <PlayerID>7</PlayerID>
        <PlayerName>sample string 8</PlayerName>
        <Second>6</Second>
        <TeamID>13</TeamID>
        <TeamName>sample string 14</TeamName>
      </MatchEvent>
      <MatchEvent>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>16</GoalsAwayTeam>
        <GoalsHomeTeam>15</GoalsHomeTeam>
        <MatchEventID>1</MatchEventID>
        <MatchEventType>sample string 3</MatchEventType>
        <MatchEventTypeID>2</MatchEventTypeID>
        <Minute>5</Minute>
        <PenaltyCode>sample string 11</PenaltyCode>
        <PenaltyName>sample string 12</PenaltyName>
        <Period>4</Period>
        <PlayerAssistID>9</PlayerAssistID>
        <PlayerAssistName>sample string 10</PlayerAssistName>
        <PlayerID>7</PlayerID>
        <PlayerName>sample string 8</PlayerName>
        <Second>6</Second>
        <TeamID>13</TeamID>
        <TeamName>sample string 14</TeamName>
      </MatchEvent>
    </Events>
    <GoalsAwayTeam>20</GoalsAwayTeam>
    <GoalsHomeTeam>19</GoalsHomeTeam>
    <HomeMatchTeamID>21</HomeMatchTeamID>
    <HomeTeam>sample string 4</HomeTeam>
    <HomeTeamID>3</HomeTeamID>
    <IntermediateResults>
      <IntermediateResult>
        <GoalsAwayTeam>3</GoalsAwayTeam>
        <GoalsHomeTeam>2</GoalsHomeTeam>
        <Period>1</Period>
      </IntermediateResult>
      <IntermediateResult>
        <GoalsAwayTeam>3</GoalsAwayTeam>
        <GoalsHomeTeam>2</GoalsHomeTeam>
        <Period>1</Period>
      </IntermediateResult>
    </IntermediateResults>
    <MatchDateTime>2024-03-29T02:45:15.4060925+01:00</MatchDateTime>
    <MatchID>1</MatchID>
    <MatchNo>sample string 2</MatchNo>
    <MatchStatus>18</MatchStatus>
    <Referee1>sample string 12</Referee1>
    <Referee1ID>11</Referee1ID>
    <Referee2>sample string 14</Referee2>
    <Referee2ID>13</Referee2ID>
    <Results>
      <MatchResult>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>4</GoalsAwayTeam>
        <GoalsHomeTeam>3</GoalsHomeTeam>
        <IsFinalResult>true</IsFinalResult>
        <MatchResultType>sample string 2</MatchResultType>
        <MatchResultTypeID>1</MatchResultTypeID>
      </MatchResult>
      <MatchResult>
        <CreatedTS>2024-03-29T02:45:15.4060925+01:00</CreatedTS>
        <GoalsAwayTeam>4</GoalsAwayTeam>
        <GoalsHomeTeam>3</GoalsHomeTeam>
        <IsFinalResult>true</IsFinalResult>
        <MatchResultType>sample string 2</MatchResultType>
        <MatchResultTypeID>1</MatchResultTypeID>
      </MatchResult>
    </Results>
    <Round>16</Round>
    <RoundName>sample string 17</RoundName>
    <ShotsOnGoal>
      <ShotsOnGoal>
        <Period>1</Period>
        <ShotsAwayTeam>3</ShotsAwayTeam>
        <ShotsHomeTeam>2</ShotsHomeTeam>
      </ShotsOnGoal>
      <ShotsOnGoal>
        <Period>1</Period>
        <ShotsAwayTeam>3</ShotsAwayTeam>
        <ShotsHomeTeam>2</ShotsHomeTeam>
      </ShotsOnGoal>
    </ShotsOnGoal>
    <Spectators>15</Spectators>
    <Venue>sample string 8</Venue>
    <VenueLatitude>9.1</VenueLatitude>
    <VenueLongitude>10.1</VenueLongitude>
  </Match>
</ArrayOfMatch>