GameListService

URL: http://landgrab.net/landgrab/services/GameListService
WSDL: http://landgrab.net/landgrab/services/GameListService?wsdl

The GameListService has methods for retrieving game details and lists of games.

Methods

getGameDetails(sessionKey, gameNumber)

Arguments:
sessionKey (xsd:string) The session key obtained from the initiateSession call
gameNumber (xsd:int) The game number

Returns: a GameSummarySoapBean object

This method returns the details of the given game (game settings, players, status, etc). For a full list of details, see the GameSummarySoapBean object.


getPublicGames(sessionKey, deepLoad)

Arguments:
sessionKey (xsd:string) The session key obtained from the initiateSession call
deepLoad (xsd:boolean) whether or not to perform a "deep load" of the games found.

Returns: An array of GameSummarySoapBean objects

This method will return a list of all currently-open public games (any game that has 1 or more public slots open).

If the "deepLoad" argument is false, each GameSummarySoapBean returned will only have the game number and game name populated. Other values are default values and are not set (some unset integers may be 0, others may be -1).
If the "deepLoad" argument is true, each GameSummarySoapBean is fully populated (this takes more time to complete).

 

getUsersGames(sessionKey, userCode, deepLoad, includeCompleted)

Arguments:
sessionKey (xsd:string) The session key obtained from the initiateSession call
userCode (xsd:int) The user account number
deepLoad (xsd:boolean) whether or not to perform a "deep load" of the games found
includeCompleted (xsd:boolean) whether or not to include completed games in the list

Returns: an array of GameSummarySoapBean objects

This method returns a list of all games the the given user is registered in.

If the "deepLoad" argument is false, each GameSummarySoapBean returned will only have the game number and game name populated. Other values are default values and are not set (some unset integers may be 0, others may be -1).
If the "deepLoad" argument is true, each GameSummarySoapBean is fully populated (this takes more time to complete).

If the "includeCompleted" argument is true, all games that the user has ever played (or is currently playing) are returned.
If the "includeCompleted" argument is false, only games that are still active are returned.