CHPP Development/XML/teamDetails

CHPP Documentation - teamDetails.asp

This page offers XML and HTML interfaces to see the basic data for a team. The XML interface enables CHPP developers to integrate these data into their applications.

Current version

Current version of the XML output is 1.7

Syntax

teamDetails.asp?
     outputType = {HTML | XML}
     actionType = {view}
     [{teamID = integer |
     userID = 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 basic team data.

teamID

What team/user to show the data for. teamID and userID generates the same result, except that ownerless teams can only be accessed if submitting a teamID and that users without a team can only be accessed if userID is submitted.

userID

What team/user to show the data for. teamID and userID generates the same result, except that ownerless teams can only be accessed if submitting a teamID and that users without a team can only be accessed if userID is submitted. If neither userID or teamID is supplied, userID defaults to the logged on user's userID.

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.

User (Within HattrickData)

Container for the data about the user ("owner").

UserID (Within User)

The globally unique UserID for the owner of the team. Teams without an owner have UserID = 0.

Language (Within User)

Container for the data about the language the user has chosen as his/her default language.

LanguageID (Within Language)

The globally unique LanguageID.

LanguageName (Within Language)

The Language name.

HasSupporter (Within User)

Boolean value indicating whether the user is currently a Hattrick Supporter. Not supplied if the team is ownerless.

Loginname (Within User)

The "username" or "nickname" used in conferences and for login. Not supplied if the team is ownerless.

Name (Within User)

The user's personal name or the value HIDDEN to indicate that the user has chosen to hide it. Not supplied if the team is ownerless.

ICQ (Within User)

The user's ICQ number (if any). Not supplied if the team is ownerless.

SignupDate (Within User)

The date and time when the user signed up for Hattrick. Not supplied if the team is ownerless.

ActivationDate (Within User)

The date and time when the user gained control of this team. Not supplied if the team is ownerless.

LastLoginDate (Within User)

The date and time when the user last logged on. Not supplied if the team is ownerless.

NationalTeamCoach (Within User)

Container for the national teams. An attribute named Count specifies how many national teams this user coaches. If 0, the child node does not exist.

NationalTeam (Within NationalTeamCoach)

Container for a National Team. An attribute called Index signifies the number of the national team in the list (not to be confused with NationalTeamID which is globally unique). Index ranges from 0 to (Count - 1).

NationalTeamID (Within NationalTeam)

The globally unique identifier of the national team.

NationalTeamName (Within NationalTeam)

The name of the national team

Team (Within HattrickData)

Container for the data about the team (not supplied for user without team).

TeamID (Within Team)

The globally unique TeamID.

TeamName (Within Team)

The full team name.

ShortTeamName (Within Team)

The short team name.

Arena (Within Team)

Container for the data about the team's home ground.

ArenaID (Within Arena)

The globally unique ArenaID.

ArenaName (Within Arena)

The arena name.

League (Within Team)

Container for the data about the league ("Sverige", "England" and so on) the team is part of.

LeagueID (Within League)

The globally unique LeagueID.

LeagueName (Within League)

The League name.

Region (Within Team)

Container for the data about the region theteam is located in.

RegionID (Within Region)

The globally unique RegionID.

RegionName (Within Region)

The Region name.

Trainer (Within Team)

The player that is trainer ("coach") for the team. (Not to be confused with the "owner"/"user").

PlayerID (Within Trainer)

The globally unique PlayerID of the player that has the job as trainer of the team.

PlayerName (Within Trainer)

The name of the trainer.

HomePage (Within Team)

The home page URL that the team has specified.

Clubhouse (Within Team)

Exists only if the team has a Hattrick Clubhouse and if so holds the name of that clubhouse. The URL of the clubhouse will then be http://club.hattrick.org/ClubhouseName/ where ClubhouseName is a placeholder for the value in tag Clubhouse.

Cup (Within Team)

Data about the team's cup status. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

StillInCup (Within Cup)

Boolean value stating if the team is still in the cup.

CupID (Within Cup)

The globally unique CupID of the cup that the team is still in. Only provided if team is still in cup.

CupName (Within Cup)

The name of the cup that the team is still in. Only provided if team is still in cup.

FriendlyBooked (Within Team)

This element is obsolete and will probably be removed within 1-2 months.

The team's status about if friendly is booked. The value is true if team has booked a friendly, false if not. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

FriendlyTeamID (Within Team)

The team's status about if a friendly is booked. The value is the opponents globally unique teamID if the team has booked a friendly, 0 if not. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

LeagueLevelUnit (Within Team)

Data about the team's LeagueLevelUnit ("series"). If the team is playing a qualification match, an attribute named Available is set to false and the container is empty, otherwise to true.

LeagueLevelUnitID (Within LeagueLevelUnit)

The globally unique LeagueLevelUnitID.

LeagueLevelUnitName (Within LeagueLevelUnit)

The name of the LeagueLevelUnit.

LeagueLevel (Within LeagueLevelUnit)

Integer value stating the relative level of the LeagueLevelUnit, with 1 indicating the league's top series.

NumberOfVictories (Within Team)

If the team is in a winning streak of at least 2 matches, this integer indicates how many victories in a row it currently has. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

NumberOfUndefeated (Within Team)

If the team is in a streak of at least 2 matches as undefeated, this integer indicates how many matches in a row it is undefeated. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

LogoURL (Within Trainer)

The logo URL that the team has specified. Only supplied if the user has Hattrick Supporter

Fanclub (Within Team)

Container for the data about the team's fanclub. Only supplied if the user has Hattrick Supporter.

FanclubID (Within Fanclub)

The globally unique FanclubID. Only supplied if the user has Hattrick Supporter.

FanclubName (Within Fanclub)

The name of the fanclub. Only supplied if the user has Hattrick Supporter.

Guestbook (Within Team)

Container for the data about the user's guestbook. Only supplied if the user has Hattrick Supporter.

NumberOfGuestbookItems (Within Guestbook)

The number of postings in the user's guestbook. Only supplied if the user has Hattrick Supporter.

PressAnnouncement (Within Team)

Container for the data about the user's most recent PressAnnouncement. Only supplied if the user has Hattrick Supporter.

Subject (Within PressAnnouncement)

The subject text specified for the PressAnnouncement. Only supplied if the user has Hattrick Supporter.

Body (Within PressAnnouncement)

The body of the PressAnnouncement. Only supplied if the user has Hattrick Supporter.

SendDate (Within PressAnnouncement)

The time and date when the PressAnnouncement was submitted. Only supplied if the user has Hattrick Supporter.

Dress (Within Team)

7 character string representing the dress of the team: First characters is a letter indicating type pf dress. Next two numbers indicate the shirt colour, next two indicate pants colour and final two numbers indicate socks colour.

DressAlternate (Within Team)

Same as dress, except that it shows the alternate dress.

BotStatus (Within Team)

Container for the data indicating if a team is a "bot", that is, has a default and random lineup and players.

IsBot (Within BotStatus)

Boolean. Specifies whether a team is currently a bot or not.

BotSince (Within BotStatus)

The date when the team was made a bot, or 1997-08-30 if the team was made a bot before 2005-12-08. If the team is not a bot, this will return 1900-01-01.

TeamRank (Within Team)

If the team has an owner, this is the League Rank, a number based on LeagueLevel, postion etc, only counting teams with an owner. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

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