External Services and Tools/API Documentation/listregions

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

Lists all regions on an island.

Parameters

Parameter Type Meaning
World integer/string Game world ID OR world name with first letters capitalized.

Output

Note: These lists are now sorted relative to one another as part of they are built.

XML

<xml>
 <listing>
  <region-ids>
   comma separated value list
  </region-ids>
  <region-names>
   comma separated value list
  </region-names>
 </listing>
</xml>

JSON

{
   "listing": {
       "region-ids": comma separated value list,
       "region-names": comma separated value list
   }
}

Example

Regions on the East Island 
http://battlemaster.org/data/listregions/1