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

From BattleMaster Wiki
Jump to navigation Jump to search
(Created page with "{{RightTOC}} Lists all realms present on on island. == Parameters== {| style="background:#eee;" |- ! Parameter ! Type ! Meaning |-valign="top" | World | integer | Game world...")
 
m
 
(4 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
|-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/JSON===
+
Note: These lists are now sorted relative to one another as part of they are built.
−
  <listing>
+
===XML===
−
   <realm-ids> ''comma-seperated list of integers'' </realm-ids>
+
  <xml>
−
   <realm-names> ''comma-seperated list of strings'' </realm-names>
+
  <listing>
−
  </listing>
+
   <realm-ids>''comma-separated list of strings''</realm-ids>
−
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 of realms with correct IDs, please use the 'world-realms' access point.
+
   <realm-names>(''comma-separated list of strings''</realm-names>
 +
  </listing>
 +
  </xml>
 +
===JSON===
 +
{
 +
    "listing": {
 +
        "realm-ids": ''comma-separated list of strings'',
 +
        "realm-names": ''comma-separated list of strings''
 +
    }
 +
}
  
 
== Example ==
 
== Example ==
 
; Realms on the East Island : http://battlemaster.org/data/listrealms/1
 
; Realms on the East Island : http://battlemaster.org/data/listrealms/1

Latest revision as of 09:42, 28 January 2022

Lists all realms present on on 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>
  <realm-ids>comma-separated list of strings</realm-ids>
  <realm-names>(comma-separated list of strings</realm-names>
 </listing>
</xml>

JSON

{
    "listing": {
        "realm-ids": comma-separated list of strings,
        "realm-names": comma-separated list of strings
    }
}

Example

Realms on the East Island 
http://battlemaster.org/data/listrealms/1
Retrieved from "https://wiki.battlemaster.org/index.php?title=External_Services_and_Tools/API_Documentation/listrealms&oldid=211201"