CHPP Development/XML/players

CHPP Documentation - players.asp

This page offers XML and HTML interfaces to the list of players 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.2.6 Latest available version of the XML output is 1.3

Syntax

players.asp?
     outputType = {HTML | XML}
     actionType = {view | viewOldies | supporterStats}
     [orderBy = {PlayerNumber | Lastname | PlayerID | Age | MarketValue}]
     [teamID = integer]
     [matchTypeCategory = {ALL | LQC | F | NT | WC}]
     [showAll = {false | true}]

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 list of players belonging to a team.
viewOldies		View the list of players who no longer belong to the club but were promoted from the youth squad of this team, or who were part of the start-up squad of the team.
supporterStats		Show players who have played matches for the team, ordered by the number of matches they have played for the team. Requires that the logged on user is a Hattrick Supporter.

orderBy

The field that the outdata PlayerList should be sorted by. Not relevant for actionType = supporterStats.

teamID

The team for which the data should apply to. Defaults to the logged on user's own TeamID if not supplied.

matchTypeCategory

Only relevant for actionType = supporterStats. Indicates one of the following types of matches:

Value	Default	Description
ALL	Default	All matches.
LQC		League, qualification and cup matches.
F		Friendlies only.

showAll

Boolean value only relevant for actionType supporterStats. Defaults to false, which means that only the 20 players with most matches are shown. If true, all players are returned.

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 team to which the data applies.

TeamID (Within Team)

The globally unique TeamID.

TeamName (Within Team)

The full team name.

PlayerList (Within Team)

Container for the list of players. An attribute named Count specifies how many players it contains.

Player (Within PlayerList)

Container for a player. An attribute named Index works as a counter.

PlayerID (Within Player)

The globally unique PlayerID.

PlayerName (Within Player)

The Player name.

PlayerNumber (Within Player)

The number (1 to 99) that the owner (if he/she is Ht Supporter) of the team has assigned this player.

Age (Within Player)

The age of the player.

AgeDays (Within Player)

The amount of days past since last birthday.

TSI (Within Player)

The Total Skill Index (TSI) of the player.

PlayerForm (Within Player)

The current form, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Statement (Within Player)

If the owner is a HT Supporter, he may have provided a Statement from his players.

Experience (Within Player)

The experience of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Leadership (Within Player)

The leadership of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

Salary (Within Player)

The salary of the player, given in the default currence (Currency rate 1. There are 10 default currency units per US$).

IsAbroad (Within Player)

The abroad status of the player, given as an integer. 0 for beeing in home country, 1 for beeing in a team abroad.

Agreeability (Within Player)

The agreeability of the player, given as an integer with 1 indicating the lowest level (se Denominations appendix of rules).

Aggressiveness (Within Player)

The aggressiveness of the player, given as an integer with 1 indicating the lowest level (se Denominations appendix of rules).

Honesty (Within Player)

The honesty of the player, given as an integer with 1 indicating the lowest level (se Denominations appendix of rules).

LeagueGoals (Within Player)

The number of goals in the league this season. If the team the player belongs to is currently playing a match, a string with value NOT AVAILABLE is returned instead of the actual number of goals. Please note that some of these data can sometimes be somewhat corrupt.

CupGoals (Within Player)

The number of goals in the cup this season. If the team the player belongs to is currently playing a match, a string with value NOT AVAILABLE is returned instead of the actual number of goals. Please note that some of these data can sometimes be somewhat corrupt.

FriendliesGoals (Within Player)

The number of goals in friendlies this season. If the team the player belongs to is currently playing a match, a string with value NOT AVAILABLE is returned instead of the actual number of goals. Please note that some of these data can sometimes be somewhat corrupt.

CareerGoals (Within Player)

The total number goals throughout this player's carreer. If the team the player belongs to is currently playing a match, a string with value NOT AVAILABLE is returned instead of the actual number of goals. Please note that some of these data have become somewhat corrupt over the years, something that cannot be fixed.

CareerHattricks (Within Player)

The total number hattricks throughout this player's carreer. If the team the player belongs to is currently playing a match, a string with value NOT AVAILABLE is returned instead of the actual number of hattricks. Please note that some of these data have become somewhat corrupt over the years, something that cannot be fixed.

Specialty (Within Player)

Integer indicating the specialty (if any) of the player:

Value	Description
0	No specialty.
1	Technical.
2	Quick.
3	Powerful.
4	Unpredictable.
5	Head specialist.

TransferListed (Within Player)

Returns 1 if the player is on the transfer list, otherwise 0.

NationalTeamID (Within Player)

If the player is enrolled on a national team, this is that national team's ID. Otherwise will return 0.

Cards (Within Player)

The number of currently accumulated cards. If the player is suspended, this will return 3 (whether the player has actually accumulated 3 bookings, or if he has become suspended by being sent off after 2 bookings in the same game). If the team the player belongs to is currently playing a match, a string with value NOT AVAILABLE is returned instead of the actual number of cards.

InjuryLevel (Within Player)

The number of weeks the player is predicted to be injured. If the player is bruised, a value of 0 is returned. If the player is healthy, a value of -1 is returned. If the team the player belongs to is currently playing a match, a string with value NOT AVAILABLE is returned instead of the actual InjuryLevel.

StaminaSkill (Within Player)

The stamina skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

KeeperSkill (Within Player)

The keeper skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

PlaymakerSkill (Within Player)

The playmaker skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

ScorerSkill (Within Player)

The scorer skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

PassingSkill (Within Player)

The passing skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

WingerSkill (Within Player)

The winger skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

DefenderSkill (Within Player)

The defender skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

SetPiecesSkill (Within Player)

The set pieces skill of the player, given as an integer with 1 indicating disastrous, 2 for wretched and so on. Only provided if the player belongs to the logged on user.

OwningTeam (Within Player)

Container for the team that owns the player. Only provided for actionType viewOldies.

TeamID (Within OwningTeam)

The globally unique TeamID of the team owning the player.

TeamName (Within OwningTeam)

The full team name of the team owning the player.

LeagueName (Within OwningTeam)

The name of the league that team owning the player is located in.

TrainerData (Within Player)

Container for the skills that relate to coach/trainer ability. Only provided if the player has been made into a trainer, "has gained trainer license". It is provided irrespective of if he is actually serving as the appointed coach of the club or not.

TrainerType (Within TrainerData)

Integer indicating the type of trainer:

Value	Description
0	Defensive
1	Offensive
2	Balanced

TrainerSkill (Within TrainerData)

The trainer skill, given as an integer with 1 indicating disastrous, 2 for wretched and so on.

CountryID (Within Player)

The CountryID that the player is native of. This is the value that is used to identify what national team the player can be enrolled to. Please note that CountryID is often not the same as LeagueID. You can use (for instance) worldDetails.asp to map a certain CountryID to a LeagueID.

Caps (Within Player)

The number of matches played for the national team.

CapsU20 (Within Player)

The number of matches played for the U-20 national team.