Difference between revisions of "External Services and Tools/API Documentation/listregions"

From BattleMaster Wiki
Jump to navigation Jump to search
m
m
 
Line 15: Line 15:
 
==Output==
 
==Output==
 
Note: These lists are now sorted relative to one another as part of they are built.
 
Note: These lists are now sorted relative to one another as part of they are built.
===XML===
 
 
{{API_RegionList}}
 
{{API_RegionList}}
  
 
== Example ==
 
== Example ==
 
; Regions on the East Island : http://battlemaster.org/data/listregions/1
 
; Regions on the East Island : http://battlemaster.org/data/listregions/1

Latest revision as of 09:34, 28 January 2022

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