CHPP Development/XML/matchOrders

From Hattrick

CHPP Documentation - matchOrders.asp

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

Current version

Current version of the XML output is 1.2.1

Syntax

matchOrders.asp?
     outputType = {HTML | XML}
     [outputVersion = version]
     matchID = 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.

outputVersion

Indicates what version of the XML to put out. Not used at the moment.

matchID

Which match to show match order data 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.

MatchID (Within HattrickData)

The globally unique matchID.

MatchData (Within HattrickData)

Container for the data about the match. If the match isn't one of your's or isn't available for laying orders an attribute named Available is set to false and the container is empty, otherwise it is set to true.

HomeTeam (Within MatchData)

The home (formal, not taking arena location into account) team of the match. An attribute named ID indicates the TeamID of the home team.

HomeTeamID (Within HomeTeam)

The globally unique teamID of the home team.

HomeTeamName (Within HomeTeam)

The team name of the home team in the match.

AwayTeam (Within MatchData)

The away (formal, not taking arena location into account) team of the match. An attribute named ID indicates the TeamID of the away team.

AwayTeamID (Within AwayTeam)

The globally unique teamID of the away team.

AwayTeamName (Within AwayTeam)

The team name of the away team in the match.

Arena (Within HattrickData)

The arena that the match will be played on. An attribute named ID indicates the ArenaID of the arena.

ArenaID (Within Arena)

The globally unique arenaID .

ArenaName (Within Arena)

The name of the arena.

MatchDate (Within MatchData)

The kick-off date of the match.

MatchType (Within MatchData)

Integer defining the type of match:

Attitude (Within MatchData)

Integer value representing the the team attitude specified for the match. If the match is a training match an attribute named Available is set to false and the element is empty, otherwise the attribute is set to true.

TacticType (Within MatchData)

An integer indicating what tactic is set for the users team.

Lineup (Within MatchData)

Container for the lineup of the requested team.

Player (Within Lineup)

Container for a particular player that is part of the lineup. An attribute named ID indicates the playerID of the player. An attribute named Index gives a counter.

PlayerID (Within Player)

The globally unique playerID.

PlayerName (Within Player)

The full name of the player.

RoleID (Within Player)

An integer indicating which formal "slot" (Role) the player will fill in the match, before the repositionings take effect. So, there can only be one (or zero) player with a particular RoleID. Roles are coded like this:

Behaviour (Within Player)

An integer indicating the individual order or repositioning that the player will play with: