Service Configuration

APIs

1.1 Get the entity definitions for the web api

Returns the defintions for the web api (Id and Description)

Method Invocation
REST Url	api/RU/configuration/entities

Response

Entity definitions V1.0 �Close Entity definitions V1.0 <?xml version="1.0" encoding="utf-8"?> <entities> <groundConditions> <groundCondition id="" name="" /> </groundConditions> <competitions> <competition id="" name="" CompetitionLogoURL=""/> </competitions> <players> <player id="" name="" /> </players> <positions> <position id="" name="" /> </positions> <rounds> <round id="" roundNumber="" seasonId="" roundName="" isActive="" /> </rounds> <scoringMethods> <scoringMethod id="" name="" statTypeID="" scoringValue="" /> </scoringMethods> <seasons> <season id="" name="" isActive=""/> </seasons> <statistics> <statistic id="" name="" statNameInt="" /> </statistics> <teams> <team id="" name="" TeamLogoURL=""/> </teams> <venues> <venue id="" name="" /> </venues> <weatherConditions> <weatherCondition id="1" name="" /> </weatherConditions> <gameStates> <gameStates id="" name="" /> </gameStates> <officials> <official id="" name="" /> </officials> </entities> Close

1.2 Retrieve Season List

Get a list of available seasons for the specified competition

Method Invocation
REST Url	api/RU/competitions/seasons/{competitionId}/{seasonId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition identifier.	Yes
seasonId	Integer	The season identifier.	No

Response

Season Schema V1.2 ×Close Season Schema V1.2 <?xml version="1.0" encoding="utf-8"?> <seasonList competitionId="" competitionName=""> <season id="2014" name="2014" active="True"> <round id="1" roundNumber="2" Name="Round 1" Matches="8" Active="True" Final="False" GrandFinal="False" PlayOff="False"> </round> <clubs> <club teamId="500001" teamName="Sydney Roosters" teamAbbr="SYD" teamLogoURL="http://urlpath/image.png"></club> <club teamId="500002" teamName="Manly-Warringah Sea Eagles" teamAbbr="MAN" teamLogoURL="http://urlpath2/image2.png"></club> </clubs> </season> <season id="2013" name="2013" active="True"></season> <season id="2012" name="2012" active="True"></season> </seasonList> Close

1.3 Retrieve a competition/season/team Schedule

Returns a list of Rounds/matches for a specified Competition and Season.

Method Invocation
REST Url	api/RU/competitions/fixtures/{competitionId}/{seasonId}/{teamId}

Parameter Name	Type	Description	Required
competitionId	Integer	Identifier of the Series	Yes
seasonId	Integer	Identifier of the season	Yes
teamId	Integer	The team identifier.	No

Response

Fixture Schema V1.07 ×Close Fixture Schema V1.07 <?xml version="1.0" encoding="UTF-8"?> <!--fixture seasonId="" competitionId="" competitionName="" seasonStartDate="" seasonFinishDate=""> <roundFixtures roundId="" roundName="" roundStartDate="" roundFinishDate=""> <gameFixtures> <gameFixture group="0" game="" gameId="" gameStateId="" gameStateName="" gameNumber="" gameHashTag="" startTime="" startTimeUTC="" venueId="" venueName="" venueTimezone=""> <teams> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="True" /> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="False" /> </teams> </gameFixture> </gameFixtures> <teamByes> <teamBye teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" /> </teamByes> </roundFixtures> </fixture--> <fixture seasonId="" competitionId="" competitionName="" seasonStartDate="" seasonFinishDate=""> <roundFixtures roundId="" roundName="" roundStartDate="" roundFinishDate=""> <gameFixtures> <gameFixture game="" gameId="" gameStateId="" gameStateName="" gameNumber="" gameHashTag="" startTime="" startTimeUTC="" venueId="" venueName="" venueTimezone="" broadcastChannel="" broadcastScheduledTime="" broadcastScheduledTimeUTC="" verboseDate=""> <!--broadcast channel to verbose data are new--> <teams> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="true"/> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="false"/> </teams> </gameFixture> </gameFixtures> <teamByes> <teamBye teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" /> </teamByes> </roundFixtures> </fixture> Close

1.4 Retrieve a competition/season/Round Schedule

Returns a list of Rounds/matches for a specified Competition and Season.

Method Invocation
REST Url	api/RU/competitions/roundFixtures/{competitionId}/{seasonId}/{roundNumber}

Parameter Name	Type	Description	Required
competitionId	Integer	Identifier of the Series	Yes
seasonId	Integer	Identifier of the season	Yes
roundNumber	Integer	The round Number identifier.	No

Response

Fixture Schema V1.07 ×Close Fixture Schema V1.07 <?xml version="1.0" encoding="UTF-8"?> <!--fixture seasonId="" competitionId="" competitionName="" seasonStartDate="" seasonFinishDate=""> <roundFixtures roundId="" roundName="" roundStartDate="" roundFinishDate=""> <gameFixtures> <gameFixture group="0" game="" gameId="" gameStateId="" gameStateName="" gameNumber="" gameHashTag="" startTime="" startTimeUTC="" venueId="" venueName="" venueTimezone=""> <teams> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="True" /> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="False" /> </teams> </gameFixture> </gameFixtures> <teamByes> <teamBye teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" /> </teamByes> </roundFixtures> </fixture--> <fixture seasonId="" competitionId="" competitionName="" seasonStartDate="" seasonFinishDate=""> <roundFixtures roundId="" roundName="" roundStartDate="" roundFinishDate=""> <gameFixtures> <gameFixture game="" gameId="" gameStateId="" gameStateName="" gameNumber="" gameHashTag="" startTime="" startTimeUTC="" venueId="" venueName="" venueTimezone="" broadcastChannel="" broadcastScheduledTime="" broadcastScheduledTimeUTC="" verboseDate=""> <!--broadcast channel to verbose data are new--> <teams> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="true"/> <team team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamFinalScore="" isHomeTeam="false"/> </teams> </gameFixture> </gameFixtures> <teamByes> <teamBye teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" /> </teamByes> </roundFixtures> </fixture> Close

1.5 Retrieve Ladder data

Returns the current Ladder for a specified Competition and Season. It is not possible to return a ladder for a previous point in time using this method.

Method Invocation
REST Url	api/RU/competitions/ladder/{competitionId}/{seasonId}/{roundNumber}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition identifier.	Yes
seasonId	Integer	The season identifier.	Yes
roundNumber	Integer	The round Number identifier.	No

Response

Ladder Schema V1.04 ×Close Ladder Schema V1.04 <?xml version="1.0" encoding="UTF-8"?> <!--ladder seasonId="" competitionId="" competitionName="" roundId=""> <ladderposition position="1" group="0" teamId="" teamName="" gamesPlayed="" wins="" draws="" losses="" byes="" competitionPoints="" bonusPoints="" pointsFor="" pointsAgainst="" pointsDifference="" triesFor="" triesAgainst="" homeWins="" homeDraws="" homeLosses="" awayWins="" awayDraws="" awayLosses="" recentForm="" /> <ladderposition position="2" group="0" teamId="" teamName="" gamesPlayed="" wins="" draws="" losses="" byes="" competitionPoints="" bonusPoints="" pointsFor="" pointsAgainst="" pointsDifference="" triesFor="" triesAgainst="" homeWins="" homeDraws="" homeLosses="" awayWins="" awayDraws="" awayLosses="" recentForm="" /> <ladderposition position="3" group="0" teamId="" teamName="" gamesPlayed="" wins="" draws="" losses="" byes="" competitionPoints="" bonusPoints="" pointsFor="" pointsAgainst="" pointsDifference="" triesFor="" triesAgainst="" homeWins="" homeDraws="" homeLosses="" awayWins="" awayDraws="" awayLosses="" recentForm="" /> <ladderposition position="4" group="0" teamId="" teamName="" gamesPlayed="" wins="" draws="" losses="" byes="" competitionPoints="" bonusPoints="" pointsFor="" pointsAgainst="" pointsDifference="" triesFor="" triesAgainst="" homeWins="" homeDraws="" homeLosses="" awayWins="" awayDraws="" awayLosses="" recentForm="" /> </ladder--> <ladder competitionId="" competitionName="" roundNumber="" seasonId=""> <!-- bonusPoints to groupName are all new attributes, and can be built off the same logic as RL. Competitions such as Super Rugby will have the group info so have included that detail as well. Note in RL it reads conceded, not against, have catered to match Rugby Union so it reads against--> <ladderposition position="" teamId="" teamName="" gamesPlayed="" wins="" draws="" losses="" byes="" competitionPoints="" pointsFor="" pointsAgainst="" pointsDifference="" homeWins="" homeDraws="" homeLosses="" awayWins="" awayLosses="" awayDraws="" triesFor="" triesAgainst="" bonusPoints="" goalsFor="" fieldGoalsFor="" goalsAgainst="" fieldGoalsAgainst="" recentForm="" group="" groupName=""/> </ladder> Close

1.6 Retrieve Competition/Season Historic statistics for team(s)

Returns team profiles and statistics for a specified Competition and Season.

Method Invocation
REST Url	api/RU/teamStats/{competitionId}/{seasonId}/{teamId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
teamId	Integer	The team identifier.	No

Response

Team Stats Schema V1.07 ×Close Team Stats Schema V1.07 <?xml version="1.0" encoding="UTF-8"?> <teamStats competitionId="241" competitionName="TOP 14"> <teams> <team teamId="1280" teamName="Agen"> <seasonStats appearances="8" seasonId="2016"> <stats> <stat StatTypeID="0" total="77.00" average="9.62" StatName="Substitution-In" StatNameInt="Substitution-In" /> </stats> </seasonStats> </team> </teams> </teamStats> Close

1.7 Retrieve Competition/Season Historic statistics for team(s)

Returns team profiles and statistics for a specified Competition and Season.

Method Invocation
REST Url	api/RU/teamStatsSnapshot/{competitionId}/{seasonId}/{teamId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
teamId	Integer	The team identifier.	No

Response

Team Stats Schema V1.07 ×Close Team Stats Schema V1.07 <?xml version="1.0" encoding="UTF-8"?> <teamStats competitionId="241" competitionName="TOP 14"> <teams> <team teamId="1280" teamName="Agen"> <seasonStats appearances="8" seasonId="2016"> <stats> <stat StatTypeID="0" total="77.00" average="9.62" StatName="Substitution-In" StatNameInt="Substitution-In" /> </stats> </seasonStats> </team> </teams> </teamStats> Close

1.8 Retrieve Competition/Season Historical statistics for player(s)

Returns player profiles and statsitics for a specified Competition and Season.

Method Invocation
REST Url	api/RU/playerStats/{competitionId}/{seasonId}/{playerId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
playerId	Integer	The player identifier.	No

Response

Player Stats Schema V1.05 ×Close Player Stats Schema V1.05 <?xml version="1.0" encoding="UTF-8"?> <playerStats seasonId="" competitionId="" competitionName=""> <players> <player playerFirstName="" playerId="" playerLastName="" playerName="" positionId="" positionName="" shirtNum="3" teamId="" teamName=""> <playerCareerStats appearances="" startingAppearances="2"> <stats> <stat StatTypeID="" total="" average="" StatName="" StatNameInt=""/> </stats> </playerCareerStats> <playerSeasonStats appearances="" startingAppearances="" seasonId="" seasonName=""> <Stat> <stat StatTypeID="" total="" average="" StatName="" StatNameInt=""/> </Stat> </playerSeasonStats> <playerTeamStats appearances="" startingAppearances="" teamId="" teamName=""> <Stat> <stat StatTypeID="" total="" average="" StatName="" StatNameInt=""/> </Stat> </playerTeamStats> </player> </players> </playerStats> Close

1.9 Retrieve Competition/Season Historical statistics for player(s)

Returns player profiles and statsitics for a specified Competition and Season.

Method Invocation
REST Url	api/RU/playerStatsSnapshot/{competitionId}/{seasonId}/{playerId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
playerId	Integer	The player identifier.	No

Response

Player Snapshot Schema V1.00 ×Close Player Snapshot Schema V1.00 <?xml version="1.0" encoding="UTF-8"?> <playerStats competitionId="" competitionName=""> <players> <player playerId="" playerName="" playerShortName="" playerFirstName="" playerLastName="" positionName="" positionId=""> <playerCurrentRoundStats fantasyPointsTotal="" fantasyPointsAverage="" onReport="" sentOff="" sinBins="" penalties="" errors="" oneOnOneTackles="" ineffectiveTackles="" missedTackles="" tackles="" supports="" decoys="" lineDropouts="" offloads="" tryAssists="" tryCause="" trySaves="" linebreakAssists="" tackleBreaks="" linebreaks="" kickReturnMetres="" bombKicksDefused="" bombKicksNotDefused="" kicksDefused="" kicksNotDefused="" kickReturns="" fortyTwentyKicks="" oneOnOneLost="" oneOnOneSteal="" kickMetres="" bombKicks="" kicks="" hitUps="" dummyHalfRuns="" allRunMetres="" allRuns="" interceptedPass="" intercepts="" chargedDown="" chargeDowns="" fieldGoalsMissed="" fieldGoalsAttempts="" penaltyGoalsMissed="" penaltyGoalsAttempts="" conversionsMissed="" conversionsAttempts="" fieldGoals="" penaltyGoals="" conversions="" fieldGoalConversionRate="" goalConversionRate="" tries="" mins="" appearances="" gameId="" roundNumber="" roundId="" seasonId="" /> <!-- playerroundstats has been changed to playerCurrentRoundStats as we will only be using one round in this feed and it will be in relation to the round most recently completed--> <playerSeasonStats fantasyPointsTotal="" fantasyPointsAverage="" onReport="" sentOff="" sinBins="" penalties="" errors="" oneOnOneTackles="" ineffectiveTackles="" missedTackles="" tackles="" supports="" decoys="" lineDropouts="" offloads="" tryAssists="" tryCause="" trySaves="" linebreakAssists="" tackleBreaks="" linebreaks="" kickReturnMetres="" bombKicksDefused="" bombKicksNotDefused="" kicksDefused="" kicksNotDefused="" kickReturns="" fortyTwentyKicks="" oneOnOneLost="" oneOnOneSteal="" kickMetres="" bombKicks="" kicks="" hitUps="" dummyHalfRuns="" allRunMetres="" allRuns="" interceptedPass="" intercepts="" chargedDown="" chargeDowns="" fieldGoalsMissed="" fieldGoalsAttempts="" penaltyGoalsMissed="" penaltyGoalsAttempts="" conversionsMissed="" conversionsAttempts="" fieldGoals="" penaltyGoals="" conversions="" fieldGoalConversionRate="" goalConversionRate="" goals="" goalsAttempts="" goalsMissed="" tries="" mins="" appearances="" seasonId="" /> <playerTeamStats fantasyPointsTotal="" sentOff="" sinBins="" errors="" oneOnOneTackles="" ineffectiveTackles="" missedTackles="" tackles="" offloads="" tryAssists="" linebreakAssists="" tackleBreaks="" linebreaks="" kickReturnMetres="" bombKicksDefused="" bombKicksNotDefused="" kicksDefused="" kickReturns="" bombKicks="" fortyTwentyKicks="" kickMetres="" kicks="" hitUps="" dummyHalfRuns="" allRunMetres="" allRuns="" fieldGoalsMissed="" fieldGoalsAttempts="" goalsMissed="" goalsAttempts="" fieldGoals="" goals="" tries="" fantasyPointsAverage="" oneOnOneLost="" oneOnOneSteal="" interceptedPass="" intercepts="" chargedDown="" chargeDowns="" penaltiesConceded="" kicksNotDefused="" points="" fieldGoalConversionRate="" goalConversionRate="" triesPerSeason="" averageMinutes="" appearances="" teamId="" /> <playerCareerStats fantasyPointsTotal="" sentOff="" sinBins="" errors="" oneOnOneTackles="" ineffectiveTackles="" missedTackles="" tackles="" offloads="" tryAssists="" linebreakAssists="" tackleBreaks="" linebreaks="" kickReturnMetres="" bombKicksDefused="" bombKicksNotDefused="" kicksDefused="" kickReturns="" bombKicks="" fortyTwentyKicks="" kickMetres="" kicks="" hitUps="" dummyHalfRuns="" allRunMetres="" allRuns="" fieldGoalsMissed="" fieldGoalsAttempts="" goalsMissed="" goalsAttempts="" fieldGoals="" goals="" tries="" fantasyPointsAverage="" oneOnOneLost="" oneOnOneSteal="" interceptedPass="" intercepts="" chargedDown="" chargeDowns="" penaltiesConceded="" kicksNotDefused="" points="" fieldGoalConversionRate="" goalConversionRate="" triesPerSeason="" averageMinutes="" appearances="" /> </player> </players> <competitionPlayerAverageStats seasonId="" appearances="" tries="" conversions="" penaltyGoalsBySeason="" fieldGoalsBySeason="" pointsBySeason="" tacklesBySeason="" allRunsBySeason="" hitUpsBySeason="" allRunMetresBySeason="" linebreaksBySeason="" offloadsBySeason="" missedTacklesBySeason="" errorsBySeason="" penaltiesBySeason="" fantasyPointsAverageByGame="" fantasyPointsAverageBySeason="" /> </playerStats> Close

1.10 Retrieve player profile information

Returns player bio for a specified Competition and Season.

Method Invocation
REST Url	api/RU/playerProfiles/{competitionId}/{seasonId}/{playerId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
playerId	Integer	The player identifier.	No

Response

Player Profile Schema V1.03 ×Close Player Profile Schema V1.03 <?xml version="1.0" encoding="UTF-8"?> <playerProfile seasonId="" competitionId="" competitionName=""> <player playerId="" playerName="" playerShortName="" playerFirstName="" playerLastName="" teamId="" teamName="" previousteamId="" previousteamName="" playerDob="" playerHeight="" playerWeight="" playerFirstGradeDebut="" playerJuniorClub="" playerClubDebut="" playerPreferredPosition="" seasonAppearances="" seasonAverageMins="" seasonAverageFantasyPoints="" seasonTotalFantasyPoints="" teamAppearances="" careerAppearances="" playerProfilePicture="" playerActive="" /> <!--all stat fields that are no longer required have been removed for the player profile feed--> </playerProfile> Close

1.11 Retrieve Squad Lists for selected Season/Competition

Returns the players currently registered at each club in the specified Season/Competition.

Method Invocation
REST Url	api/RU/clubSquads/{competitionId}/{seasonId}/{teamId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
teamId	Integer	The team identifier.	No

Response

Team Stats Schema V1.07 ×Close Team Stats Schema V1.07 <?xml version="1.0" encoding="UTF-8"?> <teamStats competitionId="241" competitionName="TOP 14"> <teams> <team teamId="1280" teamName="Agen"> <seasonStats appearances="8" seasonId="2016"> <stats> <stat StatTypeID="0" total="77.00" average="9.62" StatName="Substitution-In" StatNameInt="Substitution-In" /> </stats> </seasonStats> </team> </teams> </teamStats> Close

1.12 Retrieve Top Season Total Stat List

Get a list of Top 10 Data Stats (Season Total) for the specified competition

Method Invocation
REST Url	api/RU/competitions/topStats/{competitionId}/{seasonId}

Parameter Name	Type	Description	Required
seasonId	Integer	The season identifier.	Yes
competitionId	Integer	The competition identifier.	Yes

Response
Top Stats Schema V1.0 ×Close Top Stats Schema V1.0 <?xml version="1.0" encoding="UTF-8"?> <Stat> <Stat_Team> <Stat_Top ID="" Name="" NameInt=""> <Team ID="" Name="">value</Team> </Stat_Top> </Stat_Team> <Stat_Player> <Stat_Top ID="0" Name="" NameInt=""> <Player ID="" Name="" FirstName="" LastName="" TeamID="" TeamName="">value</Player> </Stat_Top> </Stat_Player> </Stat> Close

1.13 Retrieve Top Season Total Stat List

Get a list of Top 10 Data Stats (Season Total) for the specified competition

Method Invocation
REST Url	api/RU/competitions/topStats/SeasonTotal/{competitionId}/{seasonId}

Parameter Name	Type	Description	Required
seasonId	Integer	The season identifier.	Yes
competitionId	Integer	The competition identifier.	Yes

Response
Top Stats Schema V1.0 ×Close Top Stats Schema V1.0 <?xml version="1.0" encoding="UTF-8"?> <Stat> <Stat_Team> <Stat_Top ID="" Name="" NameInt=""> <Team ID="" Name="">value</Team> </Stat_Top> </Stat_Team> <Stat_Player> <Stat_Top ID="0" Name="" NameInt=""> <Player ID="" Name="" FirstName="" LastName="" TeamID="" TeamName="">value</Player> </Stat_Top> </Stat_Player> </Stat> Close

1.14 Retrieve Top Average Stat List

Get a list of Top 10 Data Stats (Season Average) for the specified competition

Method Invocation
REST Url	api/RU/competitions/topStats/SeasonAverage/{competitionId}/{seasonId}

Parameter Name	Type	Description	Required
seasonId	Integer	The season identifier.	Yes
competitionId	Integer	The competition identifier.	Yes

Response
Top Stats Schema V1.0 ×Close Top Stats Schema V1.0 <?xml version="1.0" encoding="UTF-8"?> <Stat> <Stat_Team> <Stat_Top ID="" Name="" NameInt=""> <Team ID="" Name="">value</Team> </Stat_Top> </Stat_Team> <Stat_Player> <Stat_Top ID="0" Name="" NameInt=""> <Player ID="" Name="" FirstName="" LastName="" TeamID="" TeamName="">value</Player> </Stat_Top> </Stat_Player> </Stat> Close

1.15 Retrieve Top Performance Stat List

Get a list of Top 10 Data Stats (individual performance) for the specified competition

Method Invocation
REST Url	api/RU/competitions/topStats/Performance/{competitionId}/{seasonId}

Parameter Name	Type	Description	Required
seasonId	Integer	The season identifier.	Yes
competitionId	Integer	The competition identifier.	Yes

Response
Top Stats Schema V1.0 ×Close Top Stats Schema V1.0 <?xml version="1.0" encoding="UTF-8"?> <Stat> <Stat_Team> <Stat_Top ID="" Name="" NameInt=""> <Team ID="" Name="">value</Team> </Stat_Top> </Stat_Team> <Stat_Player> <Stat_Top ID="0" Name="" NameInt=""> <Player ID="" Name="" FirstName="" LastName="" TeamID="" TeamName="">value</Player> </Stat_Top> </Stat_Player> </Stat> Close

1.16 Retrieve Top Season Total Stat List

Get a list of Top 10 Data Stats (Season Total) for the specified competition

Method Invocation
REST Url	api/RU/competitions/topStatsSnapshot/{competitionId}/{seasonId}

Parameter Name	Type	Description	Required
seasonId	Integer	The season identifier.	Yes
competitionId	Integer	The competition identifier.	Yes

Response
Top Stats Schema V1.0 ×Close Top Stats Schema V1.0 <?xml version="1.0" encoding="UTF-8"?> <Stat> <Stat_Team> <Stat_Top ID="" Name="" NameInt=""> <Team ID="" Name="">value</Team> </Stat_Top> </Stat_Team> <Stat_Player> <Stat_Top ID="0" Name="" NameInt=""> <Player ID="" Name="" FirstName="" LastName="" TeamID="" TeamName="">value</Player> </Stat_Top> </Stat_Player> </Stat> Close

1.17 Retrieve Competition/Season Historic statistics for team(s)

Returns team profiles and statistics for a specified Competition and Season.

Method Invocation
REST Url	api/RU/teamStatsV2/{competitionId}/{seasonId}/{teamId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
teamId	Integer	The team identifier.	No

Response

Team Stats V2 Schema V1.00 ×Close Team Stats V2 Schema V1.00 <?xml version="1.0" encoding="UTF-8"?> <teamStats competitionId="241" competitionName="TOP 14"> <teams> <team teamId="1280" teamName="Agen"> <seasonStats appearances="8" seasonId="2016"> <stats> <stat StatTypeID="0" total="77.00" average="9.62" StatName="Substitution-In" StatNameInt="Substitution-In" /> </stats> <roundStats> <round appearances="1" roundNumber="1"> <stats> <stat StatTypeID="0" total="77.00" average="9.62" StatName="Substitution-In" StatNameInt="Substitution-In" /> </stats> </round> </roundStats> </seasonStats> </team> </teams> </teamStats> Close

1.18 Retrieve Competition/Season Historical statistics for player(s)

Returns player profiles and statsitics for a specified Competition and Season.

Method Invocation
REST Url	api/RU/playerStatsV2/{competitionId}/{seasonId}/{playerId}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition id.	Yes
seasonId	Integer	The season identifier.	Yes
playerId	Integer	The player identifier.	No

Response

Player Stats V2 Schema V1.00 ×Close Player Stats V2 Schema V1.00 <?xml version="1.0" encoding="UTF-8"?> <playerStats competitionId="" competitionName=""> <players> <player playerId="" playerName="" positionId="" positionName="" teamId="" teamName="" headshotUrl=""> <seasonStats appearances="" seasonId=""> <stats> <stat StatTypeID="" total="" average="" StatName="" StatNameInt="" /> </stats> </seasonStats> <roundStats appearances="" roundId="" matchId=""> <stat StatTypeID="" total="" average="" StatName="" StatNameInt="" /> </roundStats> </player> </players> </playerStats> Close

2.1 Retrieve Match Data from a Match ID

Returns the GameStats feed relevant to the match status in the Database. The same XMl schema will be delivered regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still be represented by empty XML nodes or NULL attributes.

Method Invocation
REST Url	api/RU/matchStats/{matchId}

Parameter Name	Type	Description	Required
matchId	String	The match identifier.	Yes

Response

Game Stats Schema V1.10 ×Close Game Stats Schema V1.10 <?xml version="1.0" encoding="UTF-8"?> <gameStats seasonId="" competitionId="" competitionName="" gameId="" gameStateId="" gameState="" roundId=""> <gameInfo gameTime="" gameSeconds="" gameNumber="" startTime="" startTimeUTC="" numberOfPeriods="" gameDate="" venueId="" venueName="" gameHashTag="" weatherId="" weatherName="" groundConditionId="" groundConditionName="" referee1Id="" referee1Name="" referee2Id="" referee2Name="" assistantReferee1Id="" assistantReferee1Name="" assistantReferee2Id="" assistantReferee2Name="" videoReferee1Id="" videoReferee1Name="" videoReferee2Id="" videoReferee2Name="" crowd="" /> <teams> <teamsMatch isHomeTeam="" team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamHeadToHeadOdds="" team1stHalfScore="" teamHalfTimeScore="" team2ndHalfScore="" teamExtraTimeScore="" teamFullTimeScore="" teamFinalScore=""> <score points="" tries="" conversions="" penaltyGoals="" fieldGoals="" /> <teamStats> <periodStats> <period periodId=""> <periodStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </period> </periodStats> <matchStats> <matchStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </matchStats> </teamStats> <teamLineup teamLineupStatus=""> <teamPlayer playerId="" playerPositionId="" playerPosition="" shirtNum="" playerName="" playerFirstName="" playerLastName="" playerTookTheField="" isCaptain=""> <playerStats> <periodStats> <period periodId=""> <periodStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </period> </periodStats> <matchStats> <matchStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </matchStats> </playerStats> </teamPlayer> <insAndOuts> <inOut playerId="" playerName="" playerFirstName="" playerLastName="" inOut="" /> </insAndOuts> <injuriesAndSuspensions> <injury playerId="" playerName="" playerFirstName="" playerLastName="" injuryDescription="" /> <suspension playerId="" playerName="" playerFirstName="" playerLastName="" suspensionDescription="" /> </injuriesAndSuspensions> <playerOfTheGame playerId="" playerName="" playerFirstName="" playerLastName="" /> </teamLineup> </teamsMatch> </teams> </gameStats> Close

2.2 Retrieve Match Data from Comp/Season/Round/Game Details

Returns the GameStats feed relevant to the match status in the Database. The same XMl schema will be delivered regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still be represented by empty XML nodes or NULL attributes.

Method Invocation
REST Url	api/RU/matchStats/{competitionId}/{seasonId}/{roundNumber}/{gameNumber}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition identifier.	Yes
seasonId	Integer	The season identifier.	Yes
roundNumber	Integer	The round number identifier.	Yes
gameNumber	Integer	The game number identifier.	Yes

Response

Game Stats Schema V1.10 ×Close Game Stats Schema V1.10 <?xml version="1.0" encoding="UTF-8"?> <gameStats seasonId="" competitionId="" competitionName="" gameId="" gameStateId="" gameState="" roundId=""> <gameInfo gameTime="" gameSeconds="" gameNumber="" startTime="" startTimeUTC="" numberOfPeriods="" gameDate="" venueId="" venueName="" gameHashTag="" weatherId="" weatherName="" groundConditionId="" groundConditionName="" referee1Id="" referee1Name="" referee2Id="" referee2Name="" assistantReferee1Id="" assistantReferee1Name="" assistantReferee2Id="" assistantReferee2Name="" videoReferee1Id="" videoReferee1Name="" videoReferee2Id="" videoReferee2Name="" crowd="" /> <teams> <teamsMatch isHomeTeam="" team="" teamId="" teamName="" teamNickName="" teamAbbr="" teamPosition="" teamHeadToHeadOdds="" team1stHalfScore="" teamHalfTimeScore="" team2ndHalfScore="" teamExtraTimeScore="" teamFullTimeScore="" teamFinalScore=""> <score points="" tries="" conversions="" penaltyGoals="" fieldGoals="" /> <teamStats> <periodStats> <period periodId=""> <periodStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </period> </periodStats> <matchStats> <matchStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </matchStats> </teamStats> <teamLineup teamLineupStatus=""> <teamPlayer playerId="" playerPositionId="" playerPosition="" shirtNum="" playerName="" playerFirstName="" playerLastName="" playerTookTheField="" isCaptain=""> <playerStats> <periodStats> <period periodId=""> <periodStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </period> </periodStats> <matchStats> <matchStat StatTypeID="" StatValue="" StatName="" StatNameInt=""/> </matchStats> </playerStats> </teamPlayer> <insAndOuts> <inOut playerId="" playerName="" playerFirstName="" playerLastName="" inOut="" /> </insAndOuts> <injuriesAndSuspensions> <injury playerId="" playerName="" playerFirstName="" playerLastName="" injuryDescription="" /> <suspension playerId="" playerName="" playerFirstName="" playerLastName="" suspensionDescription="" /> </injuriesAndSuspensions> <playerOfTheGame playerId="" playerName="" playerFirstName="" playerLastName="" /> </teamLineup> </teamsMatch> </teams> </gameStats> Close

2.3 Retrieve Match Events Flow

Returns a list of Events for a match, grouped by Team and Event types. Currently, only scoring events are captured by this feed but additional event types can be captured in the same feed for future requirements.

Method Invocation
REST Url	api/RU/matchstats/eventsFlow/{matchId}

Parameter Name	Type	Description	Required
matchId	String	The match identifier.	Yes

Response

Events Flow Schema V1.02 ×Close Events Flow Schema V1.02 <?xml version="1.0" encoding="UTF-8"?> <eventFlow gameId="" roundId="" competitionName="" competitionId="" seasonId=""> <scoreFlow> <scoreEvent> <teams> <team team="" teamId="" teamAbbr="" fieldGoals="" penaltyGoals="" conversions="" tries="" points="" teamName="" isHomeTeam="True"> <statScoringEvent statValue="" playerName="" playerId="" vidRef="" gameTime="" gameState="" gameStateId="" statEvent="" statId="" scoreMethod="" homeScore="" awayScore="" /> </team> <team team="" teamId="" teamAbbr="" fieldGoals="" penaltyGoals="" conversions="" tries="" points="" teamName="" isHomeTeam="False"> <statScoringEvent statValue="" playerName="" playerId="" vidRef="" gameTime="" gameState="" gameStateId="" statEvent="" statId="" scoreMethod="" homeScore="" awayScore="" /> </team> </teams> </scoreEvent> </scoreFlow> <penaltyFlow> <penaltyEvent> <statPenaltyEvent team="" teamId="" teamName="" isHomeTeam="" statId="" statValue="" gameTime="" gameSeconds="" gameState="" gameStateId="" penaltyDescription="" vidRef=""/> </penaltyEvent> </penaltyFlow> </eventFlow> Close

2.4 Retrieve Match Events Flow by Round

Returns a list of Events for a match, grouped by Team and Event types. Currently, only scoring events are captured by this feed but additional event types can be captured in the same feed for future requirements.

Method Invocation
REST Url	api/RU/matchStats/eventsFlow/{competitionId}/{seasonId}/{roundNumber}/{gameNumber}

Parameter Name	Type	Description	Required
competitionId	Integer	The competition identifier.	Yes
seasonId	Integer	The season identifier.	Yes
roundNumber	Integer	The round number.	Yes
gameNumber	Integer	The game number.	Yes

Response

Events Flow Schema V1.02 ×Close Events Flow Schema V1.02 <?xml version="1.0" encoding="UTF-8"?> <eventFlow gameId="" roundId="" competitionName="" competitionId="" seasonId=""> <scoreFlow> <scoreEvent> <teams> <team team="" teamId="" teamAbbr="" fieldGoals="" penaltyGoals="" conversions="" tries="" points="" teamName="" isHomeTeam="True"> <statScoringEvent statValue="" playerName="" playerId="" vidRef="" gameTime="" gameState="" gameStateId="" statEvent="" statId="" scoreMethod="" homeScore="" awayScore="" /> </team> <team team="" teamId="" teamAbbr="" fieldGoals="" penaltyGoals="" conversions="" tries="" points="" teamName="" isHomeTeam="False"> <statScoringEvent statValue="" playerName="" playerId="" vidRef="" gameTime="" gameState="" gameStateId="" statEvent="" statId="" scoreMethod="" homeScore="" awayScore="" /> </team> </teams> </scoreEvent> </scoreFlow> <penaltyFlow> <penaltyEvent> <statPenaltyEvent team="" teamId="" teamName="" isHomeTeam="" statId="" statValue="" gameTime="" gameSeconds="" gameState="" gameStateId="" penaltyDescription="" vidRef=""/> </penaltyEvent> </penaltyFlow> </eventFlow> Close

2.5 Retrieve Form Guide for an upcoming match

Returns a Form Guide comprising previous match and head-to-head information for a specified match.

Method Invocation
REST Url	api/RU/matchStats/FormGuide/{matchId}

Parameter Name	Type	Description	Required
matchId	String	The match identifier.	Yes

Response

Form Guide Schema V1.00 ×Close Form Guide Schema V1.00 <?xml version="1.0" encoding="UTF-8"?> <formGuide startTimeUTC="" startTime="" gameHashTag="" venueName="" venueId="" gameId="" roundId="" competitionName="" competitionId="" seasonId=""> <teamFormGuideStats teamWinPercentage="" teamPosition="" teamAbbr="" teamName="" team="" teamId="" isHomeTeam=""> <headToHead teamTotalLosses="" teamTotalDraws="" teamTotalWins="" teamLossesVsOpposingTeam="" teamDrawsVsOpposingTeam="" teamWinsVsOpposingTeam="" teamGamesPlayedVsOpposingTeam="" teamLowestScoreAtVenue="" teamHighestScoreAtVenue="" teamLossesAtVenue="" teamDrawsAtVenue="" teamWinsAtVenue="" teamBiggestMarginAtVenue="" teamGamesPlayedAtVenue="" teamHeadToHeadLowestScore="" teamHeadToHeadHighestScore="" teamHeadToHeadBiggestMargin="" teamHeadToHeadOdds="" /> <recentRecord> <recentGame gameId="" roundId="" team="" crowd="" venueName="" weather="" weatherId="" awayTeamScore="" homeTeamScore="" result="" awayTeamName="" homeTeamName="" gameDate="" /> </recentRecord> <teamList TeamLineupStatus=""> <playerLineup playerId="" playerPositionId="" playerPosition="" shirtNum="" playerName="" playerFirstName="" playerLastName="" /> </teamList> <seasonHomeAndAwayAverages> <home team="" allRuns="" allRunMetres="" offloads="" linebreaks="" tackles="" missedTackles="" penalties="" errors="" kicks="" /> <away team="" allRuns="" allRunMetres="" offloads="" linebreaks="" tackles="" missedTackles="" penalties="" errors="" kicks="" /> </seasonHomeAndAwayAverages> <seasonTeamStats playersUsed ="" premiershipOdds="" goalKickingPercentageSeason="" setCompletionSeason="" offloadsPerGame="" linebreaksPerGame="" tacklesPerGame="" allRunMetresPerGame="" hitUpsPerGame="" runsPerGame="" kicksInPlayPerGame="" errorsPerGame="" penaltiesPerGame="" possession="" missedTacklesPerGame="" pointsConcededPerGame="" triesConcededPerGame="" pointsPerGame="" triesScoredPerGame="" losses="" draws="" wins="" wins1_12="" wins13Plus="" losses1_12="" losses13Plus=""/> <seasonWinLossBreakdown drawLoss="" drawDraw="" drawWin="" lossLoss="" lossDraw="" lossWin="" winLoss="" winDraw="" winWin="" extraTimeLoss="" extraTimeDraw="" extraTimeWin="" half1Win="" half1Draw="" half1Loss="" half2Win="" half2Draw="" half2Loss="" half1_0to20Loss="" half1_0to20Draw="" half1_0to20Win="" half1_20to40Loss="" half1_20to40Draw="" half1_20to40Win="" half2_40to60Loss="" half2_40to60Draw="" half2_40to60Win="" half2_60to80Loss="" half2_60to80Draw="" half2_60to80Win="" /> <seasonPlayerStats> <playerGame playerId="" playerName="" appearances=""> <averageStats fantasyPointsAverage="" averagePenalties="" averageErrors="" averageOneOnOneTackles="" averageIneffectiveTackles="" averageMissedTackles="" averageTackles="" averageSupports="" averageDecoys="" averageOffloads="" averageTryAssists="" averageTryCause="" averageTrySaves="" averageLinebreakAssists="" averageTackleBreaks="" averageLinebreaks="" averageKickReturnMetres="" averageBombKicksDefused="" averageBombKicksNotDefused="" averageKicksDefused="" averageKicksNotDefused="" averageKickReturns="" averageFortyTwentyKicks="" averageOneOnOneLost="" averageOneOnOneSteal="" averageKickMetres="" averageBombKicks="" averageKicks="" averageHitUps="" averageDummyHalfRuns="" averageAllRunMetres="" averageAllRuns="" averageInterceptedPass="" averageIntercepts="" averageChargedDown="" averageChargeDowns="" averageFieldGoals="" averagePenaltyGoals="" averageConversions="" averageTries="" averageMins="" /> <maxStats fantasyPointsMax="" maxPenalties="" maxErrors="" maxOneOnOneTackles="" maxIneffectiveTackles="" maxMissedTackles="" maxTackles="" maxSupports="" maxDecoys="" maxOffloads="" maxTryAssists="" maxTryCause="" maxTrySaves="" maxLinebreakAssists="" maxTackleBreaks="" maxLinebreaks="" maxKickReturnMetres="" maxBombKicksDefused="" maxBombKicksNotDefused="" maxKicksDefused="" maxKicksNotDefused="" maxKickReturns="" maxFortyTwentyKicks="" maxOneOnOneLost="" maxOneOnOneSteal="" maxKickMetres="" maxBombKicks="" maxKicks="" maxHitUps="" maxDummyHalfRuns="" maxAllRunMetres="" maxAllRuns="" maxInterceptedPass="" maxIntercepts="" maxChargedDown="" maxChargeDowns="" maxFieldGoals="" maxPenaltyGoals="" maxConversions="" maxTries="" maxMins="" /> <totalStats fantasyPointsTotal="" penalties="" errors="" oneOnOneTackles="" ineffectiveTackles="" missedTackles="" tackles="" supports="" decoys="" offloads="" tryAssists="" tryCause="" trySaves="" linebreakAssists="" tackleBreaks="" linebreaks="" kickReturnMetres="" bombKicksDefused="" bombKicksNotDefused="" kicksDefused="" kicksNotDefused="" kickReturns="" fortyTwentyKicks="" oneOnOneLost="" oneOnOneSteal="" kickMetres="" bombKicks="" kicks="" hitUps="" dummyHalfRuns="" allRunMetres="" allRuns="" interceptedPass="" intercepts="" chargedDown="" chargeDowns="" fieldGoals="" penaltyGoals="" conversions="" tries="" mins="" /> </playerGame> </seasonPlayerStats> </teamFormGuideStats> <lastTenMeetings> <game gameId="" seasonId="" roundId="" roundName="" matchSummary="" homeTeamScore="" awayTeamScore="" /> </lastTenMeetings> </formGuide> Close

2.6 Retrieve Match XY Data

Returns the Match Referee feed relevant to the match status in the Database. The same XMl schema will be delivered regardless of match state (Pre-Match, Live, Post-Match). Any data that cannot be populated in each state will still be represented by empty XML nodes or NULL attributes.

Method Invocation
REST Url	api/RU/livexy/{matchId}

Parameter Name	Type	Description	Required
matchId	String	The match identifier.	Yes

Response

Live Referee Schema V1.01 ×Close Live Referee Schema V1.01 <?xml version="1.0" encoding="utf-8"?> <liveXandY competitionId="" competitionName="" gameId="" gameState="" gameStateId="" roundId="" roundName="" seasonId=""> <teams> <team isHomeTeam="true" team1stHalfScore="" team2ndHalfScore="" teamAbbr="" teamFinalScore="" teamFullTimeScore="" teamExtraTimeScore="" teamHalfTimeScore="" teamId="" teamName="" teamNickName="" teamDirection1stHalf="" teamDirection2ndHalf="" teamDirectionExtraTime1stHalf="" teamDirectionExtraTime2ndHalf=""> <xandYFeed1stHalf> <stat statEvent="" playerId="" playerName="" statId="" statName="" gameMinutes="" vidRef="" X="" Y="" metres="" /> </xandYFeed1stHalf> <xandYFeed2ndHalf> <stat statEvent="" playerId="" playerName="" statId="" statName="" gameMinutes="" vidRef="" X="" Y="" metres="" /> </xandYFeed2ndHalf> <xandYFeedExtraTime> <stat statEvent="" playerId="" playerName="" statId="" statName="" gameMinutes="" vidRef="" X="" Y="" metres="" /> </xandYFeedExtraTime> </team> <team isHomeTeam="false" team1stHalfScore="" team2ndHalfScore="" teamAbbr="" teamFinalScore="" teamFullTimeScore="" teamExtraTimeScore="" teamHalfTimeScore="" teamId="" teamName="" teamNickName="" teamDirection1stHalf="" teamDirection2ndHalf="" teamDirectionExtraTime1stHalf="" teamDirectionExtraTime2ndHalf=""> <xandYFeed1stHalf> <stat statEvent="" playerId="" playerName="" statId="" statName="" gameMinutes="" vidRef="" X="" Y="" metres="" /> </xandYFeed1stHalf> <xandYFeed2ndHalf> <stat statEvent="" playerId="" playerName="" statId="" statName="" gameMinutes="" vidRef="" X="" Y="" metres="" /> </xandYFeed2ndHalf> <xandYFeedExtraTime> <stat statEvent="" playerId="" playerName="" statId="" statName="" gameMinutes="" vidRef="" X="" Y="" metres="" /> </xandYFeedExtraTime> </team> </teams> </liveXandY> Close