CHPP Development/XML/matchLineup - Revision history

RebelClown: Category

2007-03-23T17:44:32Z

SassineFC: categorized

2007-03-13T18:52:33Z

categorized

← Older revision		Revision as of 18:52, 13 March 2007
Line 159:		Line 159:
	An integer indicating the individual order or repositioning that the player has played with:		An integer indicating the individual order or repositioning that the player has played with:
	{{Template:Behaviour table}}		{{Template:Behaviour table}}

			[[Category:CHPP XML Pages]]

RebelClown: /* Behaviour (Within Player) */

2007-02-27T01:38:52Z

Behaviour (Within Player)

@@ Line 158: / Line 158: @@
 ===Behaviour (Within Player)===
 An integer indicating the individual order or repositioning that the player has played with:
-{|  border="0" cellpadding="2" cellspacing="2"
+{{Template:Behaviour table}}

RebelClown: /* RoleID (Within Player) */

2007-02-27T01:33:36Z

RoleID (Within Player)

@@ Line 107: / Line 107: @@
 ===RoleID (Within Player)===
 An integer indicating which formal "slot" (Role) the player has filled in the match, ''before the repositionings take effect''. So, there can only be one (or zero) player with a particular RoleID (contrary to how PositionCode works). Roles are coded like this:
-{|  border="0" cellpadding="2" cellspacing="2"
+{{Template:RoleID table}}
-|- bgcolor="#cccccc" align="left"
 ===PlayerName (Within Player)===
 The full name of the player.

RebelClown at 01:16, 27 February 2007

2007-02-27T01:16:30Z

New page

__TOC__

==CHPP Documentation - matchLineup.asp==
This page offers XML and HTML interfaces to see the lineup, team experience and player ratings for a certain team and match. The XML interface enables CHPP developers to integrate these data into their applications.

{{CHPP Documentation}}

{{XML Current version | version=1.1}}

==Syntax==
<code>
matchLineup.asp?
outputType = {HTML | XML}
actionType = {view | lastmatch}
[matchID = integer]
[teamID = integer]
</code>

==Indata parameters==

{{XML outputType}}

===actionType===
Indicates what type of action the page should perform. Only the view is available for XML use.
{| border="0" cellpadding="2" cellspacing="2"
|- bgcolor="#cccccc" align="left"
! Value
! Default
! Description
|- bgcolor="#dddddd" valign="top"
| view
| Default if matchID is provided
| View a specified match. If provided, a matchID must be sent.
|- bgcolor="#dddddd" valign="top"
| lastmatch
| Default if matchID is '''not''' provided
| View the data for the latest match of the specified team.
|}

===matchID===
Specifies which particular match data is requested for. If matchID is not specified, actionType will automatically default to lastmatch.

===teamID===
If actionType = view, TeamID specifies which of the two participating teams data shuld be shown for. If actionType = lastmatch (or if matchID is not specified), TeamID indicates which team the latest lineup should be retrieved for. If TeamID is not specified, it will default to the logged on user's team.

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

===MatchID (Within HattrickData)===
The ID number of the match the output is relevant for.

===HomeTeam (Within HattrickData)===
The home (formal, not taking arena location into account) team of the match.

===HomeTeamID (Within HomeTeam)===
The globally unique teamID of the home team.

===HomeTeamName (Within HomeTeam)===
The team name of the home team in the match.

===AwayTeam (Within HattrickData)===
The away (formal, not taking arena location into account) team of the match. An attribute named ID indicates the TeamID of the away team.

===AwayTeamID (Within AwayTeam)===
The globally unique teamID of the away team.

===AwayTeamName (Within AwayTeam)===
The team name of the away team in the match.

===MatchType (Within HattrickData)===
Integer defining the type of match:
{{Template:Match type table}}

===Arena (Within HattrickData)===
The arena that the match was played on.

===ArenaID (Within Arena)===
The globally unique arenaID.

===ArenaName (Within Arena)===
The name of the arena.

===MatchDate (Within HattrickData)===
The kick-off date of the match.

===Team (Within HattrickData)===
Container for the data for the requested team.

===TeamID (Within Team)===
The globally unique teamID.

===TeamName (Within Team)===
The team's full name.

===ExperienceLevel (Within Team)===
The aggregated experience level of the team, coded into an integer, with 1 indicating disastrous, 2 indicating wretched and so forth.

===Lineup (Within Team)===
Container for the lineup of the requested team.

===Player (Within Lineup)===
Container for a particular player that is part of the lineup. An attribute named Index gives a counter.

===PlayerID (Within Player)===
The globally unique playerID.

===RoleID (Within Player)===
An integer indicating which formal "slot" (Role) the player has filled in the match, ''before the repositionings take effect''. So, there can only be one (or zero) player with a particular RoleID (contrary to how PositionCode works). Roles are coded like this:
{| border="0" cellpadding="2" cellspacing="2"
|- bgcolor="#cccccc" align="left"
! RoleID
! Description
|- bgcolor="#dddddd" valign="top"
| 1
| Keeper.
|- bgcolor="#dddddd" valign="top"
| 2
| Right back.
|- bgcolor="#dddddd" valign="top"
| 3
| Central Defender 1.
|- bgcolor="#dddddd" valign="top"
| 4
| Central Defender 2.
|- bgcolor="#dddddd" valign="top"
| 5
| Left Back.
|- bgcolor="#dddddd" valign="top"
| 6
| Right winger.
|- bgcolor="#dddddd" valign="top"
| 7
| Inner Midfield 1.
|- bgcolor="#dddddd" valign="top"
| 8
| Inner Midfield 2.
|- bgcolor="#dddddd" valign="top"
| 9
| Left winger.
|- bgcolor="#dddddd" valign="top"
| 10
| Forward 1.
|- bgcolor="#dddddd" valign="top"
| 11
| Forward 2.
|- bgcolor="#dddddd" valign="top"
| 12
| Substitution (Keeper).
|- bgcolor="#dddddd" valign="top"
| 13
| Substitution (Defender).
|- bgcolor="#dddddd" valign="top"
| 14
| Substitution (Inner Midfield).
|- bgcolor="#dddddd" valign="top"
| 15
| Substitution (Winger).
|- bgcolor="#dddddd" valign="top"
| 16
| Substitution (Forward).
|- bgcolor="#dddddd" valign="top"
| 17
| Set Pieces.
|- bgcolor="#dddddd" valign="top"
| 18
| Captain.
|- bgcolor="#dddddd" valign="top"
| 19
| Replaced player 1.
|- bgcolor="#dddddd" valign="top"
| 20
| Replaced player 2.
|- bgcolor="#dddddd" valign="top"
| 21
| Replaced player 3.
|}
===PlayerName (Within Player)===
The full name of the player.

===RatingStars (Within Player)===
The number of stars the player is rated for.

===PositionCode (Within Player)===
An integer indicating the position the player played at, ''after repositioning (behaviour) has been taken into account''. So, there can be several players with PositionCode 10 (Forward 1). Players who are not on the field do not get a PositionCode. Strictly speaking, PositionCode could be calculated using RoleID and Behaviour and is formally redundant, but it is provided anyway. PositionCodes are coded like this:
{| border="0" cellpadding="2" cellspacing="2"
|- bgcolor="#cccccc" align="left"
! PositionCode
! Description
|- bgcolor="#dddddd" valign="top"
| 1
| Keeper.
|- bgcolor="#dddddd" valign="top"
| 2
| Right back.
|- bgcolor="#dddddd" valign="top"
| 3
| Central Defender 1.
|- bgcolor="#dddddd" valign="top"
| 4
| Central Defender 2.
|- bgcolor="#dddddd" valign="top"
| 5
| Left Back.
|- bgcolor="#dddddd" valign="top"
| 6
| Right winger.
|- bgcolor="#dddddd" valign="top"
| 7
| Inner Midfield 1.
|- bgcolor="#dddddd" valign="top"
| 8
| Inner Midfield 2.
|- bgcolor="#dddddd" valign="top"
| 9
| Left winger.
|- bgcolor="#dddddd" valign="top"
| 10
| Forward 1.
|- bgcolor="#dddddd" valign="top"
| 11
| Forward 2.
|}

===Behaviour (Within Player)===
An integer indicating the individual order or repositioning that the player has played with:
{| border="0" cellpadding="2" cellspacing="2"
|- bgcolor="#cccccc" align="left"
! Behaviour
! Description
|- bgcolor="#dddddd" valign="top"
| 0
| Normal.
|- bgcolor="#dddddd" valign="top"
| 1
| Offensive.
|- bgcolor="#dddddd" valign="top"
| 2
| Defensive.
|- bgcolor="#dddddd" valign="top"
| 3
| Towards Middle.
|- bgcolor="#dddddd" valign="top"
| 4
| Towards Wing.
|- bgcolor="#dddddd" valign="top"
| 5
| Extra forward.
|- bgcolor="#dddddd" valign="top"
| 6
| Extra inner midfield.
|- bgcolor="#dddddd" valign="top"
| 7
| Extra defender.
|}

← Older revision		Revision as of 17:44, 23 March 2007
Line 160:		Line 160:
	{{Template:Behaviour table}}		{{Template:Behaviour table}}

	[[Category:CHPP XML Pages]]		[[Category:CHPP XML Pages\|Match lineup]]