External Services and Tools/API Documentation/region

From BattleMaster Wiki
< External Services and Tools‎ | API Documentation
Revision as of 09:31, 28 January 2022 by Kagurati (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Request information about a particular region.

Parameters

Parameter Type Meaning
World integer/string Game world ID OR world name with first letters capitalized.
Region integer/sting ID number or name of the region in question. You can find the ID through the listregions.php script, or by examining the URL of the "Details" link on the Region List page, or (if the page is already set up correctly) on the region's page here in the wiki. Can be replaced by Name

Output

XML

<xml>
 <regiondata>
  <id>string</id>
  <continent>string</continent>
  <continentid>string</continentid>
  <name>string</name>
  <type>string</type>
  <area>string</area>
  <population>integer</population>
  <economy>comma-separated list of strings</economy>
  <realm>string</realm>
  <duchy>string</duchy>
  <lord>string</lord>
  <xpos>integer</xpos>
  <ypos>integer</ypos>
  <colour>integer</colour>
  <banner>integer</banner>
 </regiondata>
</xml>

JSON

 {
   "regiondata": {
       "id": string,
       "continent": string,
       "continentid": string,
       "name": string,
       "type": string,
       "area": string,
       "population": integer,
       "economy": comma-separated list of strings,
       "realm": string,
       "duchy": string,
       "lord": string,
       "xpos": integer,
       "ypos": integer,
       "colour": string,
       "banner": string
   }
 }

Example

The City of Libidizedd by ID 
http://battlemaster.org/data/region.php?World=8&ID=200
The City of Eidulb by name 
http://battlemaster.org/data/region.php?World=8&Name=Eidulb