Settlements

Gets a list of settlements, and its members.

Description

This method should be used if you want to get a list of all users on the server.

URL

http://api.quelsolaar.com/serverid/settlements

HTTP Methods:

• GET

Parameters:

• {bounding boxes}
  If omitted, then show all settlements on server.

Response

A HTTP Response Code in the header.

The response is a XML document, with the following format:

• One Server Object
• An array of Settlement Objects - may me omitted if none

Contains a standard Server Object with an optional array of settlement objects.

Response Example

http://api.quelsolaar.com/3/settlements

<?xml version="1.0" encoding="UTF-8"?>
<server id="3">
  <name>Atlanta #1</name>
  <location>Atlanta, Georgia, USA</location>
  <armageddon>false</armageddon>
  <settlement_count>1</settlement_count>
  <uptime>86400</uptime>
  <users_active>7</users_active>
  <time>1274969671</time>
</server>
<settlements>
  <settlement id="309">
    <coordinate>127:127:I</coordinate>
    <name>Settlement Name</name>
  <lifetime>7200</lifetime>
    <users>
      <user>
        <name>Fieldeon</name>
        <friendname>FieldeonsFriend</friendname>
        <players>
          <player server="3" status="online" role="mother">Rastabon</player>
          <player server="1" status="offline">Phadon</player>
        </players>
      </user>
      <user>
        <name>rawr</name>
        <friendname>SamakonsFriend</friendname>
        <players>
          <player server="3" status="online">Samakon</player>
        </players>
      </user>
      <user>
        <name>nicomallo</name>
        <friendname>nicosfriend</friendname>
        <players>
          <player server="3" status="online">Pleione</player>
        </players>
      </user>
    </users>
  <tokens>
    <token id="1" coordinate="127:127:I" />
    <token id="4" coordinate="127:124:I">
      <param name="frequency" value="99.7mhz" />
      <param name="target" value="120:103:I" />
      <param name="locked" value="false" />
    </token>
  </tokens>
  </settlement>
</settlements>

Ideas

• Add to settlement object: the boundries of the settlement (radius).