XMLLive Service

From HLSW Wiki

Jump to: navigation, search

The XMLLive Service is a web service that allows real time (live) game server access via standard web service interfaces over internet. It is accessible via http://xmllive.hlsw.org:25000/ . XMLLive supports all games that are supported by HLSW (see http://www.hlsw.org/hlsw/supported_games/ for a list of supported games). It can be used e.g. to display the status like hostname, playing users etc. of one game server on an web page or use it to develop handy apps.


Contents

Functions

XMLLive provides atm the following functions:

Serverquery

Serverquery is the basic service provided by XMLLive. It allows you to query the status of an game server. For more information see Serverquery (XMLLive Service).

Rcon

Rcon describes a set of functions that can be used to remote control a game server. It is atm in development and not available yet.

URL

The URL is organized as follows:

http://xmllive.hlsw.org:25000/<format>/<function>/<param_1>/.../<param_n>

Format

The service supports several protocols. With the format you can control the output format. It supports the following values:

Value Description
xml XML format
xmlrpc XML-RPC format
php PHP array format
json JSON format
jsonp JSON with Padding format. The name of the callback function can by specified by the ?callback=name parameter
cfg HLSW config format

For xmlrpc it is also possible that the request is also in XML-RPC. In that case send a XML-RPC request via HTTP POST to http://xmllive.hlsw.org:25000/xmlrpc . The method name as well as the parameters are encoded in the XML-RPC request.

Function

The function specifies a function name that is executed.

Param

Each function requires a specific number of parameters. If the number of parameters is not correct an error message is sent.

Most function parameters that are in ascii format do not require a special encoding. A space can be expressed by + or %20. Since the parameters are seperated by / this character must be replaced by %2f. In general function parameters are UTF-8 encoded and afterwards urlencoded (replace special chars with %<hex><hex>).

Personal tools