CHPP Development/XML/club: Difference between revisions
No edit summary |
RebelClown (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
__TOC__ | |||
< | This page offers XML and HTML interfaces to see the logged on user's club data. The XML interface enables CHPP developers to integrate these data into their applications. | ||
Indicates what type of action the page should perform. | |||
{{XML Current version | version=1.0}} | |||
Latest available version of the XML output is 1.0 | |||
==Syntax== | |||
<code> | |||
club.asp? | |||
outputType = {HTML | XML} | |||
actionType = {view} | |||
</code> | |||
==Indata parameters== | |||
{{XML outputType}} | |||
===actionType=== | |||
Indicates what type of action the page should perform. | |||
<table border="0" cellpadding="2" cellspacing="2"> | <table border="0" cellpadding="2" cellspacing="2"> | ||
<tr bgcolor="#cccccc"> | <tr bgcolor="#cccccc"> | ||
| Line 15: | Line 31: | ||
</tr> | </tr> | ||
</table> | </table> | ||
==Outdata parameters== | |||
{{XML default outparams verbose}} | |||
===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. | |||
===Specialists (Within Team)=== | |||
Container for the data about specialists. | |||
===KeeperTrainers (Within Specialists)=== | |||
The number of Keeper Trainers. | |||
===AssistantTrainers (Within Specialists)=== | |||
The number of Assistant Trainers. | |||
===Psychologists (Within Specialists)=== | |||
The number of Psychologists. | |||
===PressSpokesmen (Within Specialists)=== | |||
The number of Press Spokesmen. | |||
===Economists (Within Specialists)=== | |||
The number of Economists. | |||
===Physiotherapists (Within Specialists)=== | |||
The number of Physiotherapists. | |||
===Doctors (Within Specialists)=== | |||
The number of Doctors. | |||
===YouthSquad (Within Team)=== | |||
Container for the data about the youth squad. | |||
===Investment (Within YouthSquad)=== | |||
The weekly youth squad invstment. | |||
===HasPromoted (Within YouthSquad)=== | |||
Boolean value indicating if the team has promoted a youth player this week. | |||
===YouthLevel (Within YouthSquad)=== | |||
Integer describing the current level of the youth squad. | |||
'''Note''': Date format is always YYYY-MM-DD HH:MM:SS. | |||
Revision as of 19:54, 22 February 2007
This page offers XML and HTML interfaces to see the logged on user's club data. The XML interface enables CHPP developers to integrate these data into their applications.
Current version
Current version of the XML output is 1.0 Latest available version of the XML output is 1.0
Syntax
club.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 general club 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.
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 team.
TeamID (Within Team)
The globally unique TeamID.
TeamName (Within Team)
The name of the team.
Specialists (Within Team)
Container for the data about specialists.
KeeperTrainers (Within Specialists)
The number of Keeper Trainers.
AssistantTrainers (Within Specialists)
The number of Assistant Trainers.
Psychologists (Within Specialists)
The number of Psychologists.
PressSpokesmen (Within Specialists)
The number of Press Spokesmen.
Economists (Within Specialists)
The number of Economists.
Physiotherapists (Within Specialists)
The number of Physiotherapists.
Doctors (Within Specialists)
The number of Doctors.
YouthSquad (Within Team)
Container for the data about the youth squad.
Investment (Within YouthSquad)
The weekly youth squad invstment.
HasPromoted (Within YouthSquad)
Boolean value indicating if the team has promoted a youth player this week.
YouthLevel (Within YouthSquad)
Integer describing the current level of the youth squad.
Note: Date format is always YYYY-MM-DD HH:MM:SS.
