CHPP Development/XML/leagueFixtures

From Hattrick

Jump to: navigation, search

Contents

This page offers XML and HTML interfaces to see the league fixtures for a particular LeagueLevelUnit ("series"). The XML interface enables CHPP developers to integrate this data into their applications.

Current version

Current version of the XML output is 1.1

Syntax

leagueFixtures.asp?
     outputType = {HTML | XML}
     actionType = {view}
     [leagueLevelUnitID = integer]
     [season = integer]

Indata parameters

outputType

Indicates whether the output to the client should be an HTML document or an XML file. Only the XML document may be used for CHPP use.

actionType

Indicates what type of action the page should perform. Only the view is available for XML use.

Value Default Description
view Yes Get the league fixtures list.

leagueLevelUnitID

Specifies the "series" (leagueLevelUnit) that you are looking for data on. If not specified, it defaults to the LeaguelevelUnitID of the team of the currently logged on user.

season

The local season that fixtures is requested for. If not specified, it defaults to the current season.

Outdata parameters

The XML output can contain the following tags/containers:

HattrickData

Generic tag wrapped around all XML data from Hattrick.

FileName (Within HattrickData)

The name of the file that your request was sent to.

UserID (Within HattrickData)

The logged on User's UserID (not to be confused with TeamID). If not logged on, it defaults to 0.

Version (Within HattrickData)

The current version number of the XML output.

FetchedDate (Within HattrickData)

Date and time when the XML file was fetched. Format is YYYY-MM-DD HH:MM:SS.

LeagueLevelUnitName (Within HattrickData)

The name of the LeagueLevelUnit.

Season (Within HattrickData)

The season that the returned data applies to.

Match (Within HattrickData)

Container for the data for a certain match within the fixtures. An attribute named ID indicates the MatchID.

MatchRound (Within Match)

MatchRound that the match is part of.

HomeTeam (Within Match)

The home team container.

HomeTeamID (Within HomeTeam)

The home team's TeamID.

HomeTeamName (Within HomeTeam)

The home team's full name.

AwayTeam (Within Match)

The away team.

AwayTeamID (Within AwayTeam)

The away team's TeamID.

AwayTeamName (Within AwayTeam)

The away team's full name.

MatchDate (Within Match)

The date indicating when kick-off takes/took place.

HomeGoals (Within Match)

The final number of goals that the home team scored. This parameter is only sent for matches that are finished.

AwayGoals (Within Match)

The final number of goals that the away team scored. This parameter is only sent for matches that are finished.

Personal tools