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

From BattleMaster Wiki
Jump to navigation Jump to search
m
m
Line 20: Line 20:
 
  <xml>
 
  <xml>
 
   <listing>
 
   <listing>
−
   <realm-ids>0,1,3,11,26,29,30,37,38</realm-ids>
+
   <realm-ids>''comma-separated list of strings''</realm-ids>
−
   <realm-names>
+
   <realm-names>(''comma-separated list of strings''</realm-names>
−
    (rogue),Perdan,Sirion,Caligus,Eponllyn,Yssrgard,Perleone,Shadowdale,Alexandria
 
−
  </realm-names>
 
 
   </listing>
 
   </listing>
 
  </xml>
 
  </xml>
Line 29: Line 27:
 
  {
 
  {
 
     "listing": {
 
     "listing": {
−
         "realm-ids": "0,1,3,11,26,29,30,37,38",
+
         "realm-ids": ''comma-separated list of strings'',
−
         "realm-names": "(rogue),Perdan,Sirion,Caligus,Eponllyn,Yssrgard,Perleone,Shadowdale,Alexandria"
+
         "realm-names": ''comma-separated list of strings''
 
     }
 
     }
 
  }
 
  }

Revision as of 09:38, 29 December 2021

Lists all realms present on on island.

Parameters

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

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=210797"