CHPP Development/XML/alliances

Current version

Current version of the XML output is 1.0 Latest available version of the XML output is 1.0

Syntax

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

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

Value	Default	Description
listAll		List federations, possibly narrowed down by search criterias.

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.