CHPP Development/XML/leagueDetails: Difference between revisions

Latest revision as of 21:23, 16 March 2007

CHPP Documentation - leagueDetails.asp

This page offers XML and HTML interfaces to see data about a LeagueLevelUnit (in the vernacular known as a "series" or even "league"). The XML interface enables CHPP developers to integrate series data viewing 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.1

Syntax

leagueDetails.asp?
     outputType = {HTML | XML}
     actionType = {view}
     [leagueLevelUnitID = 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.

Value	Default	Description
view	Yes	Get the LeaguelevelUnit data.

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.

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.

LeagueID (Within HattrickData)

The ID number of the League (for instance Sverige, USA, England...) that this LeaguelevelUnit is part of.

LeagueName (Within HattrickData)

The name of the League (for instance Sverige, USA, England...) that this LeaguelevelUnit is part of.

LeagueLevel (Within HattrickData)

Indicates the division/level this LeaguelevelUnit is located on. 1 is the top division, the second best is 2 and so on.

MaxLevel (Within HattrickData)

How many divisions/levels there are in this league.

LeagueLevelUnitID (Within HattrickData)

The ID number of the LeagueLevelUnit.

LeagueLevelUnitName (Within HattrickData)

The name of the LeagueLevelUnit.

Team (Within HattrickData)

Container for the data for a certain event. An attribute named Index exists as a counter.

TeamID (Within Team)

The globally unique team indentifier.

Position (Within Team)

Position in the table.

TeamName (Within Team)

The team's full name.

Matches (Within Team)

How many matches the team has played.

GoalsFor (Within Team)

How many goals the team has scored.

GoalsAgainst (Within Team)

How many goals the team has allowed their opponents to score.

Points (Within Team)

How many points the team has.

@@ Line 1: / Line 1: @@
-Current version of the XML output is 1.1
+__TOC__
-<b>actionType</b><br>
+==CHPP Documentation - leagueDetails.asp==
-Indicates what type of action the page should perform. Only the view is available for XML use.<br><br>
+This page offers XML and HTML interfaces to see data about a LeagueLevelUnit (in the vernacular known as a "series" or even "league"). The XML interface enables CHPP developers to integrate series data viewing into their applications.
-<table border="0" cellpadding="2" cellspacing="2">
-<tbody><tr bgcolor="#cccccc">
+{{CHPP Documentation}}
-	<td valign="top"><b>Value</b></td>
-	<td valign="top"><b>Default</b></td>
+{{XML Current version | version=1.1}}
-	<td valign="top"><b>Description</b></td>
-</tr>
+== Syntax ==
-<tr bgcolor="#dddddd">
+<code>
-	<td valign="top">view</td>
+ leagueDetails.asp?
-	<td valign="top">Yes</td>
+      outputType = {HTML | XML}
-	<td valign="top">Get the LeaguelevelUnit data.</td>
+      actionType = {view}
-</tr>
+      [leagueLevelUnitID = integer]
-</tbody></table>
+</code>
-<br>
-<br>
+==Indata parameters==
-<b>leagueLevelUnitID</b><br>
-Specifies the "series" (leagueLevelUnit) that you are looking for data
+{{XML outputType}}
-on. If not specified, it defaults to the LeaguelevelUnitID of the team
-of the currently logged on user. <br>
+===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
+| Yes
+| Get the LeaguelevelUnit data.
+|}
+===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.
+==Outdata parameters==
+{{XML default outparams}}
+===LeagueID (Within HattrickData)===
+The ID number of the League (for instance Sverige, USA, England...) that this LeaguelevelUnit is part of.
+===LeagueName (Within HattrickData)===
+The name of the League (for instance Sverige, USA, England...) that this LeaguelevelUnit is part of.
+===LeagueLevel (Within HattrickData)===
+Indicates the division/level this LeaguelevelUnit is located on. 1 is the top division, the second best is 2 and so on.
+===MaxLevel (Within HattrickData)===
+How many divisions/levels there are in this league.
+===LeagueLevelUnitID (Within HattrickData)===
+The ID number of the LeagueLevelUnit.
+===LeagueLevelUnitName (Within HattrickData)===
+The name of the LeagueLevelUnit.
+===Team (Within HattrickData)===
+Container for the data for a certain event. An attribute named '''Index''' exists as a counter.
+===TeamID (Within Team)===
+The globally unique team indentifier.
+===Position (Within Team)===
+Position in the table.
+===TeamName (Within Team)===
+The team's full name.
+===Matches (Within Team)===
+How many matches the team has played.
+===GoalsFor (Within Team)===
+How many goals the team has scored.
+===GoalsAgainst (Within Team)===
+How many goals the team has allowed their opponents to score.
+===Points (Within Team)===
+How many points the team has.
+[[Category:CHPP XML Pages|League details]]