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

From BattleMaster Wiki
Jump to navigation Jump to search
m
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
Lists, uncorrelated, all regions on an island.
+
Lists all regions on an island.
  
 
==Parameters==
 
==Parameters==
Line 9: Line 9:
 
|-valign="top"
 
|-valign="top"
 
| World
 
| World
| integer
+
| integer/string
| Game world ID you access, see [[#World IDs]]
+
| Game world ID OR world name with first letters capitalized.
 
|}
 
|}
  
 
==Output==
 
==Output==
===XML===
 
<xml>
 
  <listing>
 
  <realm-ids>0,1,3,11,26,29,30,37,38</realm-ids>
 
  <realm-names>
 
    (rogue),Perdan,Sirion,Caligus,Eponllyn,Yssrgard,Perleone,Shadowdale,Alexandria
 
  </realm-names>
 
  </listing>
 
</xml>
 
===JSON===
 
{
 
    "listing": {
 
        "realm-ids": "0,1,3,11,26,29,30,37,38",
 
        "realm-names": "(rogue),Perdan,Sirion,Caligus,Eponllyn,Yssrgard,Perleone,Shadowdale,Alexandria"
 
    }
 
}
 
 
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.
 +
{{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