CHPP Development/XML/nationalTeamDetails.asp

From Hattrick
Jump to navigationJump to search

CHPP Documentation - nationalTeamDetails.asp

This page offers XML and HTML interfaces to see the details of a National Team. 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 Latest available version of the XML output is 1.1

Syntax

nationalTeamDetails.asp?
     outputType = {HTML | XML}
     [outputVersion = float]
     actionType = view
     TeamID = 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.

outputVersion

What version to show. During transition to a new version, both old and new versions may be available. Default may vary, according to information given in the CHPP conference.

actionType

Indicates what type of action the page should perform.

Value Default Description
view Default View the details of a specific national team.

TeamID

What national team to list.

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.

Version (Within HattrickData)

The current version number of the XML output.

UserID (Within HattrickData)

The logged on User's UserID (not to be confused with TeamID). If not logged on, it defaults to 0.

UserIsSupporter (Within HattrickData)

Indicated if the fetching user has a supporter subscription or not. Return 1 if the user has a supporter subscription. 0 otherwise.

UserHasClubhouse (Within HattrickData)

Indicated if the fetching user has a ClubHouse or not. Return 1 if the user has a ClubHouse. 0 otherwise.

FetchedDate (Within HattrickData)

Date and time when the XML file was fetched. Format is YYYY-MM-DD HH:MM:SS.

ActionType (Within HattrickData)

The requested ActionType.

ActionResult (Within HattrickData)

Has 1 attribute: "Success" with value 1 if everything went ok, otherwise 0. Content in ActionResult is OK if the request was successful, otherwise a short error message should be returned.

Team (Within HattrickData)

Container for the data about the national team.

TeamID (Within Team)

The globally unique TeamID.

TeamName (Within Team)

The full team name.

NationalCoach (Within Team)

Container for the data about the national coach).

NationalCoachUserID (Within NationalCoach)

The globally unique UserID for the national coach of the team.

NationalCoachLoginname (Within NationalCoach)

The "username" or "nickname" used in conferences and for login.

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.

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.

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.

Experience433 (Within Team)

The team's experience of playing 4-3-3, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Experience451 (Within Team)

The team's experience of playing 4-5-1, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Experience352 (Within Team)

The team's experience of playing 3-5-2, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Experience532 (Within Team)

The team's experience of playing 5-3-2, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Experience343 (Within Team)

The team's experience of playing 3-4-3, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Experience541 (Within Team)

The team's experience of playing 5-4-1, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Morale (Within Team)

The morale/team spirit of the team given as an integer with 4 indicating composed, 5 calm and accordingly. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

SelfConfidence (Within Team)

The self confidence of the team given as an integer with 4 indicating decent, 5 strong and accordingly. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

RatingScore (Within Team)

A integer that indicates the current rating score of the national team. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

FanClubSize (Within Team)

A integer that indicates the current fanclub size of the national team.

Rank (Within Team)

A integer that indicates the current rank of the national team.