CHPP Development/XML/CupMatches - Revision history

RebelClown: Category

2007-03-23T17:29:36Z

SassineFC at 18:48, 13 March 2007

2007-03-13T18:48:37Z

← Older revision		Revision as of 18:48, 13 March 2007
Line 109:		Line 109:
	===AwayLeagueName (Within LeagueInfo)===		===AwayLeagueName (Within LeagueInfo)===
	The league name of the away team in the match.		The league name of the away team in the match.

			[[Category:CHPP XML Pages]]

RebelClown: /* Indata parameters */ Revert

2007-03-12T13:36:40Z

Indata parameters: Revert

@@ Line 22: / Line 22: @@
 ==Indata parameters==
-[b][u]Round 1 ~  13.03.2007 [/u][/b]
-[1] ufukspor [teamid=1711868] -  :  - zahirspor [teamid=1712859]
+{{XML outputType}}
-[2] darude [teamid=658696] -  :  - bangladeş [teamid=1713403]
-[3] MERAL SPOR [teamid=1713324] -  :  - CLUB BLACKSTONE [teamid=659299]
+===actionType===
 ==Outdata parameters==

88.232.188.139: /* Indata parameters */

2007-03-11T21:24:18Z

Indata parameters

@@ Line 22: / Line 22: @@
 ==Indata parameters==
+[b][u]Round 1 ~  13.03.2007 [/u][/b]
-{{XML outputType}}
+[1] ufukspor [teamid=1711868] -  :  - zahirspor [teamid=1712859]
+[2] darude [teamid=658696] -  :  - bangladeş [teamid=1713403]
-===actionType===
+[3] MERAL SPOR [teamid=1713324] -  :  - CLUB BLACKSTONE [teamid=659299]
 ==Outdata parameters==

RebelClown at 18:47, 27 February 2007

2007-02-27T18:47:21Z

New page

__TOC__

==CHPP Documentation - CupMatches.asp==
This page offers XML and HTML interfaces to see the matches for a specific season and cupround for a cup. The XML interface enables CHPP developers to integrate these data into their applications.

'''N.B.''': The page name starts with a capital, as opposed to all other page names.

{{CHPP Documentation}}

{{XML Current version | version=1.1}}

==Syntax==
<code>
cupmatches.asp?
outputType = {HTML | XML}
actionType = view
CupID = integer
CupRound = integer
[Season = integer]
[StartAfterMatchID = integer]
</code>

==Indata parameters==

{{XML outputType}}

===actionType===
Indicates what type of action the page should perform.
{| border="0" cellpadding="2" cellspacing="2"
|- bgcolor="#cccccc" align="left"
! Value
! Default
! Description
|- bgcolor="#dddddd" valign="top"
| view
| Default
| View the match list of the cup. A maximum of 256 matches are returned, ordered by matchid. For more matches, see parameter '''StartAfterMatchID'''.
|}

===CupID===
What cup to show the matches for.

===Season===
What season to show the matches for. Defaults to the current season for the cup, if no season is supplied.

===CupRound===
What cupround to show the matches for.

===StartAfterMatchID===
Optional parameter. If left out it defaults to 0 (zero). For large cups in the first round, there will be more than 256 matches to display. To be able to fetch the next 256 matches, take the last MatchID you received from the XML-output. Send it as StartAfterMatchID=<MatchID>. This will return the next 256 matches with MatchID > StartAfterMatchID.

==Outdata parameters==
{{XML default outparams verbose}}

===Cup (Within HattrickData)===
Container for the cup and the matches.

===CupID (Within Cup)===
The global unique CupID

===CupSeason (Within Cup)===
The season of the matcehs.

===CupRound (Within Cup)===
The cupround of the matches.

===CupName (Within Cup)===
The name of the cup.

===Matches (Within Cup)===
Container for the matches. An attribute named '''Count''' specifies how many matches it contains. This is 0 if no matches exists.

===Match (Within Matches)===
A match. An attribute called '''Index''' signifies the number of the match in the list (not to be confused with MatchID which is globabbly unique). Index ranges from 0 to (Count - 1).

===MatchID (Within Match)===
The globally unique identifier of the match.

===MatchDate (Within Match)===
The start date (kick-off) of the match.

===HomeTeamName (Within Match)===
The team name of the Home team in the match.

===AwayTeamName (Within Match)===
The team name of the away team in the match.

===MatchResult (Within Match)===
Container for the match results. An attribute named '''Available''' with values true/false specifies whether or not the match result is available.

===HomeGoals (Within MatchResult)===
The number of goals for the home team. If the match is still upcoming or ongoing, this tag is not sent.

===AwayGoals (Within MatchResult)===
The number of goals for the away team. If the match is still upcoming or ongoing, this tag is not sent.

===LeagueInfo (Within Match)===
Container for information about the participating team's league. An attribute named '''Available''' with values true/false specifies whether or not the league information is available.

===HomeLeagueID (Within LeagueInfo)===
The LeagueID of the home team in the match.

===AwayLeagueID (Within LeagueInfo)===
The LeagueID of the away team in the match.

===HomeLeagueName (Within LeagueInfo)===
The league name of the home team in the match.

===AwayLeagueName (Within LeagueInfo)===
The league name of the away team in the match.

← Older revision		Revision as of 17:29, 23 March 2007
Line 110:		Line 110:
	The league name of the away team in the match.		The league name of the away team in the match.

	[[Category:CHPP XML Pages]]		[[Category:CHPP XML Pages\|Cup matches]]