aom.scripting.eso.stats

Interface StatsService

public interface StatsService

This is an interface specifying what functionality the stat server offers related to retrieving certain data. Note that this is just an abstraction, the stat server works with XML in- and output to accomplish these tasks. The actual location of the stat server for AoM, respectively AoT is:

• http://stats2.aom.eso.com/AOM_RC0/query/query.aspx?<?xml version="1.0" encoding="utf-16"?><clr><cmd v='query'/><co g='AOM_RC0' s='100' /><myQueryXml /></clr>
• http://stats2.aom.eso.com/AOM_XPACK/query/query.aspx?<?xml version="1.0" encoding="utf-16"?><clr><cmd v='query'/><co g='AOM_XPACK' s='100' /><myQueryXml /></clr>

Query specific XML should be inserted where the <myQueryXml /> template is shown.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

See Also:

Detailed Query Format in DTD

Method Summary

Modifier and Type	Method and Description
Document	qed(String id, String en, EntityType et, GameMode md, TimePeriod tp, int fe, int me, DataGroup dg) Player Units Query.
Document	qer(String id, String en, EntityType et, GameMode md, TimePeriod tp, int si, int np, int nn, RanktableName rn) Player Rank Query.
Document	qest(String id, String en, EntityType et, GameMode md, TimePeriod tp, int si) Player Info Query.
Document	qgs(String id, String gi) Game Details Query.
Document	qse(String id, String en, EntityType et, int fe, int me) Player Search Query.
Document	qsg(String id, String en, EntityType et, GameMode md, int fe, int me) Recent Games Query.

Method Detail

qgs

Document qgs(String id,
             String gi)

Game Details Query. Returns an XML document containing detailed statistics about the specified game.

Parameters:

id - Optional. A query ID, in case more queries are included in 1 request. This ID is replicated in the response element matching this query. Query IDs need not be unique.

gi - Required. The ID of the game to retrieve info for. These IDs can be found in getGames() queries.

Returns:

Game details.

Example

<qgs gi="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" />

qsg

Document qsg(String id,
             String en,
             EntityType et,
             GameMode md,
             int fe,
             int me)

Recent Games Query. Returns an XML document containing a list of recent games matching the given criteria.

Parameters:

id - Optional. A query ID, in case more queries are included in 1 request. This ID is replicated in the response element matching this query. Query IDs need not be unique.

en - Optional. The Entity Name (i.e. Player Name) to retrieve games from. If no name is provided, games of all players will be retrieved.

et - Optional. The Entity Type of the player to retrieve games from. If no type is provided, games of all player types will be retrieved.

md - Optional. The Game Mode of the games to be retrieved. If no mode is provided, games of all modes will be retrieved.

fe - The First Index: this is sort of an offset to enable retrieving paginated results. Defaults to 0. Ranges from 0 to 1000.

me - The Max number of Entries - starting from the First Index - to be retrieved. Defaults to 1000. Ranges from 0 to 1000.

Returns:

Recent games.

Example

<qsg />

qest

Document qest(String id,
              String en,
              EntityType et,
              GameMode md,
              TimePeriod tp,
              int si)

Player Info Query. Returns an XML document containing detailed statistics about the specified player.

Parameters:

id - Optional. A query ID, in case more queries are included in 1 request. This ID is replicated in the response element matching this query. Query IDs need not be unique.

en - Optional. The Entity Name (i.e. Player Name) to retrieve info for. If no name is provided, community statistics will be retrieved.

et - Required. The Entity Type of the given player.

md - Required. The Game Mode for which the info should be retrieved.

tp - Required. The Time Period for which the info should be retrieved.

si - Optional. Unknown integer.

Returns:

Player info.

Example

<qest et="ZS_Human" md="ZS_Supremacy" tp="ZS_AllTime" />

qer

Document qer(String id,
             String en,
             EntityType et,
             GameMode md,
             TimePeriod tp,
             int si,
             int np,
             int nn,
             RanktableName rn)

Player Rank Query. Returns an XML document containing the rank of the given player, and optionally those near him on the ladder.

Parameters:

id - Optional. A query ID, in case more queries are included in 1 request. This ID is replicated in the response element matching this query. Query IDs need not be unique.

en - Optional. The Entity Name (i.e. Player Name) to retrieve the rank for. If no name is provided, players at the top of the ladder will be retrieved.

et - Required. The Entity Type of the given player.

md - Required. The Game Mode for which the player rank should be retrieved.

tp - Required. The Time Period for which the player rank should be retrieved.

si - Optional. Unknown integer.

np - Required. Number of Previous players - just above the specified player - to retrieve. Ranges from 0 to 1000.

nn - Required. Number of Next players - just under the specified player - to retrieve. Ranges from 0 to 1000.

rn - Required. The Ranktable Name to retrieve the ranks from.

Returns:

Player rank.

Example

<qer et="ZS_Human" md="ZS_Supremacy" tp="ZS_AllTime" np="0" nn="20" rn="ZS_TopPlayers" />

qse

Document qse(String id,
             String en,
             EntityType et,
             int fe,
             int me)

Player Search Query. Returns an XML document containing player names that all start with the provided search query.

Parameters:

id - Optional. A query ID, in case more queries are included in 1 request. This ID is replicated in the response element matching this query. Query IDs need not be unique.

en - Required. The first letters of the Entity Name (i.e. Player Name) to search for.

et - Required. The Entity Type of the given player.

fe - The First Index: this is sort of an offset to enable retrieving paginated results. Defaults to 0. Ranges from 0 to 1000.

me - The Max number of Entries - starting from the First Index - to be retrieved. Defaults to 1000. Ranges from 0 to 1000.

Returns:

Player search results.

Example

<qse en="DoD_" et="ZS_Human" />

qed

Document qed(String id,
             String en,
             EntityType et,
             GameMode md,
             TimePeriod tp,
             int fe,
             int me,
             DataGroup dg)

Player Units Query. Returns an XML document containing detailed unit statistics of the specified player.

Parameters:

id - Optional. A query ID, in case more queries are included in 1 request. This ID is replicated in the response element matching this query. Query IDs need not be unique.

en - Optional. The Entity Name (i.e. Player Name) to retrieve unit data for. If no name is provided, community statistics will be retrieved.

et - Required. The Entity Type of the given player.

md - Required. The Game Mode for which the unit info should be retrieved.

tp - Required. The Time Period for which the unit info should be retrieved.

fe - The First Index: this is sort of an offset to enable retrieving paginated results. Defaults to 0. Ranges from 0 to 1000.

me - The Max number of Entries - starting from the First Index - to be retrieved. Defaults to 1000. Ranges from 0 to 1000.

dg - Required. The Data Group to which the returned units should belong.

Returns:

Player's units.

Example

<qed et="ZS_Human" md="ZS_Supremacy" tp="ZS_AllTime" dg="ZS_MyU" />