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

From BattleMaster Wiki
Jump to navigation Jump to search
(Created page with "Lists, uncorrelated, all regions on an island. ==Parameters== {| style="background:#eee;" |- ! Parameter ! Type ! Meaning |-valign="top" | World | integer | Game world ID you...")
 
Line 14: Line 14:
  
 
==Output==
 
==Output==
===XML/JSON===
+
===XML===
  <listing>
+
  <xml>
   <region-ids> ''comma-seperated list of integers'' </region-ids>
+
  <listing>
   <region-names> ''comma-seperated list of strings'' </region-names>
+
   <realm-ids>0,1,3,11,26,29,30,37,38</realm-ids>
  </listing>
+
   <realm-names>
Note that these two lists ''are not sorted relative to each other'', so you can ''not'' take entry #x from one list and think it corresponds to entry #x from the other. IDs are listed numerically, names are listed alphabetically. For a list with correctly correlated IDs and names, please use the 'world-regions' access point.
+
    (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.
  
 
== Example ==
 
== Example ==
 
; Regions on the East Island : http://battlemaster.org/data/listregions/1
 
; Regions on the East Island : http://battlemaster.org/data/listregions/1

Revision as of 02:39, 29 December 2021

Lists, uncorrelated, all regions on an island.

Parameters

Parameter Type Meaning
World integer Game world ID you access, see #World IDs

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.

Example

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