CHPP Development/XML/economy: Difference between revisions

From Hattrick
Jump to navigationJump to search
RebelClown (talk | contribs)
No edit summary
SassineFC (talk | contribs)
categorized
Line 133: Line 133:
===LastWeeksTotal (Within Team)===
===LastWeeksTotal (Within Team)===
The economic result for the team last week.
The economic result for the team last week.
[[Category:CHPP XML Pages]]

Revision as of 18:51, 13 March 2007

This page offers XML and HTML interfaces to the logged on user's economy page. The XML interface enables CHPP developers to integrate these data into their applications.

Current version

Current version of the XML output is 1.0

Syntax

economy.asp?
     outputType = {HTML | XML}
     actionType = {view}

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 economy data.

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.

Team (Within HattrickData)

Container for the data about the team.

TeamID (Within Team)

The globally unique TeamID.

TeamName (Within Team)

The name of the team.

Cash (Within Team)

The team's cash.

ExpectedCash (Within Team)

The budgeted cash for next week for the team.

SponsorsPopularity (Within Team)

The popularity among the sponsors of the team. If the team is playing a match, an attribute named Available is set to false and the container is empty, otherwise to true.

SupportersPopularity (Within Team)

The popularity among the supporters of the 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)

The size of the team's fanclub.

IncomeSpectators (Within Team)

The budgeted income from spectators for the team this week.

IncomeSponsors (Within Team)

The budgeted income from sponsors for the team this week.

IncomeFinancial (Within Team)

The budgeted financial income for the team this week.

IncomeTemporary (Within Team)

The budgeted temporary income for the team this week.

IncomeSum (Within Team)

The budgeted total income for the team this week.

CostsArena (Within Team)

The budgeted costs of the arena for the team this week.

CostsPlayers (Within Team)

The budgeted costs of the players for the team this week.

CostsFinancial (Within Team)

The budgeted financial costs for the team this week.

CostsTemporary (Within Team)

The budgeted temporary costs for the team this week.

CostsStaff (Within Team)

The budgeted costs of the staff for the team this week.

CostsYouth (Within Team)

The budgeted costs of the youth squad for the team this week.

CostsSum (Within Team)

The budgeted total cost for the team this week.

ExpectedWeeksTotal (Within Team)

The budgeted economic result for the team this week.

LastIncomeSpectators (Within Team)

The income from spectators for the team last week.

LastIncomeSponsors (Within Team)

The income from sponsors for the team last week.

LastIncomeFinancial (Within Team)

The financial income for the team last week.

LastIncomeTemporary (Within Team)

The temporary income for the team last week.

LastIncomeSum (Within Team)

The total income for the team last week.

LastCostsArena (Within Team)

The costs of the arena for the team last week.

LastCostsPlayers (Within Team)

The costs of the players for the team last week.

LastCostsFinancial (Within Team)

The financial costs for the team last week.

LastCostsTemporary (Within Team)

The temporary costs for the team last week.

LastCostsStaff (Within Team)

The costs of the staff for the team last week.

LastCostsYouth (Within Team)

The costs of the youth squad for the team last week.

LastCostsSum (Within Team)

The total cost for the team last week.

LastWeeksTotal (Within Team)

The economic result for the team last week.