RebelClown: Category

2007-03-23T17:48:17Z

SassineFC: categorized

2007-03-13T18:54:22Z

categorized

← Older revision		Revision as of 18:54, 13 March 2007
Line 113:		Line 113:
	===ErrorMessage (Within SearchResults)===		===ErrorMessage (Within SearchResults)===
	If there was an error when performing the search, this contains the error message.		If there was an error when performing the search, this contains the error message.

			[[Category:CHPP XML Pages]]

RebelClown at 11:42, 5 March 2007

2007-03-05T11:42:19Z

New page

__TOC__

==CHPP Documentation - search.asp==
This page offers XML and HTML interfaces to the search page. The XML interface enables CHPP developers to integrate these data into their applications.

{{CHPP Documentation}}

{{XML Current version | version=1.1}}

==Syntax==
<code>
search.asp?
outputType = {HTML | XML}
actionType = {view}
searchWhat = {team | player | arena | region}
searchType = {BEGINS | EQUALS}
[loginName = string]
[teamID = integer]
[firstName = string]
[lastName = string]
[teamName = string]
[playerID = integer]
[regionName = string]
[arenaName = string]
</code>

==Indata parameters==

{{XML outputType}}

===actionType===
Indicates what type of action the page should perform.
{| border="0" cellpadding="2" cellspacing="2"
|- bgcolor="#cccccc" align="left"
! Value
! Default
! Description
|- bgcolor="#dddddd" valign="top"
| view
| Default
| View the results of a query.
|}

===searchWhat===
Indicates what to search for.
{| border="0" cellpadding="2" cellspacing="2"
|- bgcolor="#cccccc" align="left"
! Value
! Default
! Description
|- bgcolor="#dddddd" valign="top"
| BEGINS
| Default
| Finds strings that begins with the sought for value.
|- bgcolor="#dddddd" valign="top"
| EQUALS
|
| Finds strings that equals the sought for value.
|}

===loginName===
If this is provided, and searchWhat = "team", a search will be performed based on loginName. (This criterion has the highest priority within Team search).

===firstName and lastName===
These parameters has a dual function, being used for both searchWhat = "team" and searchWhat = "player".

If both these are provided, and searchWhat = "team" and loginName is not provided, a search will be performed based on the user's name as supplied upon application. Users who have opted to hide their name will not be found.

If both these are provided, and searchWhat = "player" and playerID is not provided, a search will be performed based on the player's name. There is no searching on nicknames available.

===teamID===
If this is provided, and searchWhat = "team" and none of firstName, lastName and loginName is provided, a search will be performed based on teamName. Only EQUALS searchType is available.

===teamName===
If this is provided, and searchWhat = "team" and none of teamID, firstName, lastName and loginName is provided, a search will be performed based on teamName. (This criterion has the lowest priority within Team search).

===playerID===
If this is provided, and searchWhat = "player" a search will be performed based on playerID. Only EQUALS searchType is available.

===regionName===
If this is provided, and searchWhat = "region" a search will be performed based on regionName.

===arenaName===
If this is provided, and searchWhat = "arena" a search will be performed based on arenaName.

==Outdata parameters==
{{XML default outparams}}

===ActionType (Within HattrickData)===
The initial actionType that was submitted for the page.

===SearchWhat (Within HattrickData)===
Returns the input searchWhat parameter.

===SearchType (Within HattrickData)===
Returns the input searchType parameter.

===SearchResults (Within HattrickData)===
Container for the search results. An attribute named Count indicate the number of records returned. No more than 50 records can be returned.

===Result (Within SearchResults)===
Container for a particular record within the search results. Has an attribute named Index.

===ResultID (Within Result)===
A globally unique record ID: teamID, playerID, regionID or arenaID depending on searchWhat.

===ResultName (Within Result)===
The full name of the team, player, region or arena.

===MoreRecordsExist (Within SearchResults)===
If there are more than 50 records available for the specified criteria, this will return true, otherwise false.

===ErrorMessage (Within SearchResults)===
If there was an error when performing the search, this contains the error message.

← Older revision		Revision as of 17:48, 23 March 2007
Line 114:		Line 114:
	If there was an error when performing the search, this contains the error message.		If there was an error when performing the search, this contains the error message.

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

CHPP Development/XML/search - Revision history

RebelClown: Category

SassineFC: categorized

RebelClown at 11:42, 5 March 2007