CHPP Development/XML/regionDetails

CHPP Documentation - regionDetails.asp

This page offers XML and HTML interfaces to see the basic data for a region. 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.1

Syntax

regionDetails.asp?
     outputType = {HTML | XML}
     actionType = {view}
     [regionID = 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	Default	View the region data.

regionID

What region to show the data for. If not supplied, it defaults to the logged on user's region.

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.

League (Within HattrickData)

Container for the data about the league that the region is located in.

LeagueID (Within League)

The globally unique LeagueID for the league.

LeagueName (Within League)

The name of the league.

Region (Within HattrickData)

Container for the data about the region.

RegionID (Within Region)

The globally unique RegionID.

RegionName (Within Region)

The region name.

NumberOfUsers (Within Region)

The number of active users in the region.

NumberOfOnline (Within Region)

The number of users currently online from the region.

WeatherID (Within Region)

Integer defining the current weather:

WeatherID	Description
0	Rain.
1	Overcast.
2	Partially Cloudy.
3	Sunny.

TomorrowWeatherID (Within Region)

Integer defining the forecast for tomorrow. Defined using the same values as WeatherID.

Note: Date format is always YYYY-MM-DD HH:MM:SS.