CHPP Development/XML/worldDetails

CHPP Documentation - worldDetails.asp

This page offers XML and HTML interfaces that presents some overview and global data used in Hattrick, including lists of all leagues. The XML interface enables CHPP developers to integrate these data into their applications.

Current version

Current version of the XML output is 1.2

Syntax

worldDetails.asp?
     outputType = {HTML | XML}
     actionType = {leagues | languages}

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
leagues	Default	Show a list of all leagues.
languages		Show a list of all languages.

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.

LanguageList (Within HattrickData)

Container for the list of languages. An Attribute named Count specifies how many languages it contains. Only provided for actionType = languages. Most languages are not user languages, but since some of them may at some future point become so, the full list is provided. Most of the languages are only used in relation to player's, to determine their names and only show up in the "I speak..." statement on playerDetails.

Language (Within LanguageList)

Container for the data about a particular language. An Attribute named Index works as a counter.

LanguageID (Within Language)

The globally unique LanguageID.

LanguageName (Within Language)

The Language name.

LeagueList (Within HattrickData)

Container for the list of leagues. An Attribute named Count specifies how many leagues it contains. Only provided for actionType = leagues.

League (Within LeagueList)

Container for the league. An Attribute named Index works as a counter.

LeagueID (Within League)

The globally unique LeagueID.

LeagueName (Within League)

The League name.

Season (Within League)

The current season number of the league.

MatchRound (Within League)

The current match round of the league.

ShortName (Within League)

The short name of the league (used in some places with little room on the site).

Continent (Within League)

The name of the continent it is defined to be part of in Hattrick.

ZoneName (Within League)

The name of the zone the league is defined to be part of in Hattrick.

EnglishName (Within League)

The English name of the league.

Country (Within League)

Container for the country that is related to the league. It may seem confusing what the difference is between a league and a country. Well, there isn't much, except that in some cases we refer to CountryID instead of LeagueID. The easiest way to deal with it is perhaps to just say: "It's the way it is. Just learn to live with it.". Some things are formally tied to the Country instead of the League. We have chosen to maintain that relationship in the XML output, hence the sub-containers of Country.

CountryID (Within Country)

The globally unique CountryID of country.

CountryName (Within Country)

The name of the country.

CurrencyName (Within Country)

The name of the currency in this country.

CurrencyRate (Within Country)

Decimal value specifying the relative currency rate.

Cup (Within League)

Data about the league's default cup.

CupID (Within Cup)

The globally unique CupID

CupName (Within Cup)

The name of the cup.

ActiveUsers (Within League)

Integer specifying the number of active users in the league, as of last daily count.

WaitingUsers (Within League)

Integer specifying the number of users on the waiting list in the league. These users are not included in the ActiveUsers, so ActiveUsers + WaitingUsers would give a sort of total number of users.

TrainingDate (Within League)

The date and time when the next training update will start in this league.

EconomyDate (Within League)

The date and time when the next economy update will start in this league.

CupMatchDate (Within League)

The date and time when the next cup round is being checked for (that is, there are not necessarily any matches to play, if the cup has been finished).

SeriesMatchDate (Within League)

The date and time when the next series match round starts. Some leagues may have several series match dates - then this data gives the date when the first batch for the league starts.

NumberOfLevels (Within League)

Integer representing the number of LeagueLevels (divisions) active for this league.