CHPP Development/XML/matchesArchive: Difference between revisions

Latest revision as of 17:45, 23 March 2007

CHPP Documentation - matchesArchive.asp

This page offers XML and HTML interfaces to the match archive data. The XML interface enables CHPP developers to integrate these data into their applications.

Important!

Please note that it is strictly forbidden to develop applications that works with this or other XML/hrf files unless you are a CHPP developer. It is also illegal to use other applications than standard browsers or CHPP approved programs to access the data on the site. Violation of these rules might render you to lose your team.

Only the XML version of this file may be included in CHPP applications.

Current version

Current version of the XML output is 1.0

Syntax

matches.asp?
     outputType = {HTML | XML}
     actionType = {view | refreshCache}
     [teamID = integer]
     [LastMatchDate = Date]

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.

Value	Default	Description
view	Default	View the match list of the team.
viewCup		View the match list, cup matches, in a specific season for the team.

teamID

What team to show the matches for.

FirstMatchDate

First date to show matches in archive from. Default is three months ago.

LastMatchDate

Last date to show matches in archive to. Default is last midnigt. If more than 50 matches have occured since FirstMatchDate, only the 50 first will be returned.

Season

Which season to show cup matches for.

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.

Team (Within HattrickData)

The team that the list applies to.

TeamID (Within Team)

The team's TeamID.

TeamName (Within Team)

The full name of the team.

FirstMatchDate (Within Team)

First date to show matches in archive from.

LastMatchDate (Within Team)

Last date to show matches in archive to.

MatchList (Within Team)

Container for the matches. An Attribute called Count specifies how many matches it contains. If more than 50 matches have occured between FirstMatchDate and LastMatchDate, only the 50 first will be returned.

Match (Within MatchList)

A match. An attribute called Index signifies the number of the match in the list (not to be confused with MatchID which is globally unique).

MatchID (Within Match)

The globally unique identifier of the match.

HomeTeam (Within Match)

The Home (formal, not taking arena location into account) team of the match.

HomeTeamID (Within HomeTeam)

The teamID of the Home team in the match.

HomeTeamName (Within HomeTeam)

The team name of the Home team in the match.

AwayTeam (Within Match)

The away (formal, not taking arena location into account) team of the match.

AwayTeamID (Within AwayTeam)

The teamID of the away team in the match.

AwayTeamName (Within AwayTeam)

The team name of the away team in the match.

MatchDate (Within Match)

The start date (kick-off) of the match.

MatchType (Within Match)

Integer defining the type of match:

MatchType	Description
1	League match.
2	Qualification match.
3	Cup match (standard league cup).
4	Friendly (normal rules).
5	Friendly (cup rules).
6	Not currently in use, but reserved for international competition matches with normal rules (may or may not be implemented at some future point).
7	Hattrick Masters
8	International friendly (normal rules).
9	International friendly (cup rules).
10	National teams competition match (normal rules).
11	National teams competition match (cup rules).
12	National teams friendly.

HomeGoals (Within Match)

The number of goals for the home team. If the match is still upcoming or ongoing, this tag is not sent.

AwayGoals (Within Match)

The number of goals for the away team. If the match is still upcoming or ongoing, this tag is not sent.

Revision as of 18:53, 13 March 2007 view source SassineFC (talk \| contribs) 851 edits categorized ← Older edit		Latest revision as of 17:45, 23 March 2007 view source RebelClown (talk \| contribs) 357 edits m Category
Line 108:		Line 108:
	The number of goals for the away team. If the match is still upcoming or ongoing, this tag is not sent.		The number of goals for the away team. If the match is still upcoming or ongoing, this tag is not sent.

	[[Category:CHPP XML Pages]]		[[Category:CHPP XML Pages\|Matches archive]]