CHPP Development/XML/alliances - Revision history

RebelClown: Category

2007-03-23T17:31:01Z

SassineFC at 18:46, 13 March 2007

2007-03-13T18:46:34Z

← Older revision		Revision as of 18:46, 13 March 2007
Line 71:		Line 71:
	===AllianceDescription (Within Alliance)===		===AllianceDescription (Within Alliance)===
	Description of the federation.		Description of the federation.

			[[Category:CHPP XML Pages]]

RebelClown: /* Outdata parameters */

2007-02-22T01:10:33Z

Outdata parameters

← Older revision		Revision as of 01:10, 22 February 2007
Line 54:		Line 54:

	==Outdata parameters==		==Outdata parameters==
	~~The XML output can contain the following tags/containers:~~

	{{XML default outparams verbose}}		{{XML default outparams verbose}}

RebelClown: /* Outdata parameters */ Used Template:XML default outparams verbose

2007-02-22T01:09:00Z

Outdata parameters: Used Template:XML default outparams verbose

@@ Line 56: / Line 56: @@
 The XML output can contain the following tags/containers:
-===HattrickData===
+{{XML default outparams verbose}}
 ===Alliances (Within HattrickData)===

RebelClown at 00:57, 22 February 2007

2007-02-22T00:57:34Z

← Older revision		Revision as of 00:57, 22 February 2007
Line 81:		Line 81:

	===ActionResult (Within HattrickData)===		===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.		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.

	===Alliances (Within HattrickData)===		===Alliances (Within HattrickData)===

RebelClown at 00:37, 22 February 2007

2007-02-22T00:37:44Z

New page

__TOC__
{{XML Current version | version=1.0}}
Latest available version of the XML output is 1.0

==Syntax==
<code>
alliances.asp?
outputType = {HTML | XML}
[outputVersion = float]
actionType = listAll
[SearchLanguageID = integer]
[SearchFor = string]
[SearchForName = string]
[SearchForAbbr = string]
[SearchForDesc = string]
</code>

==Indata parameters==

{{XML outputType}}

===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===
<TABLE BORDER="0" CELLSPACING="2" CELLPADDING="2">

<TR BGCOLOR="#CCCCCC">
<TD VALIGN="top"><B>Value</B></TD>
<TD VALIGN="top"><B>Default</B></TD>
<TD VALIGN="top"><B>Description</B></TD>
</TR>
<TR BGCOLOR="#DDDDDD">
<TD VALIGN="top">listAll</TD>

<TD VALIGN="top"></TD>
<TD VALIGN="top">List federations, possibly narrowed down by search criterias.</TD>
</TR>
</TABLE>
===SearchLanguageID===
Specifies a language to restrict the federations on the list to.

===SearchFor===
Let the list include only federations with names beginning with search string or description including search string.

===SearchForName===
Let the list include only federations with names including search string. (Does not work when SearchFor is used)

===SearchForAbbr===
Let the list include only federations with abbreviation including search string. (Does not work when SearchFor or SearForName is used)

===SearchForDesc===
Let the list include only federations with description including search string. (Does not work when SearchFor, SearchForName or SearchForAbbr is used)

==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.

===Alliances (Within HattrickData)===
Container for the list of federation. An Attribute named Count specifies how many federations it contains.

===Alliance (Within Alliances)===
Container for a federation. An Attribute named Index works as a counter.

===AllianceID (Within Alliance)===
The globally unique AllianceID.

===AllianceName (Within Alliance)===
The name of the federation.

===AllianceDescription (Within Alliance)===
Description of the federation.

← Older revision		Revision as of 17:31, 23 March 2007
Line 72:		Line 72:
	Description of the federation.		Description of the federation.

	[[Category:CHPP XML Pages]]		[[Category:CHPP XML Pages\|Alliances]]