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

From BattleMaster Wiki
Jump to navigation Jump to search
m
m
Line 9: Line 9:
 
|-valign="top"
 
|-valign="top"
 
| World
 
| World
| integer OR string
+
| integer/string
 
| Game world ID OR world name with first letters capitalized.
 
| Game world ID OR world name with first letters capitalized.
 
|}
 
|}
Line 16: Line 16:
 
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===
 
===XML===
<xml>
+
{{API_RegionList}}
<listing>
 
  <region-ids>
 
  1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,124,125,126,127
 
  </region-ids>
 
  <region-names>
 
  Akesh Temple,Morshes,Evora,Sordidus,Aestus,Scio,Nascot,Bescanon,Meuse,Winkamus,Domus,Supra,Aureus,Tokat,Viseu,Braga,Dulbin,Hagley,Westmoor,Troyes,Poitiers,Bruck,Gadlock,Kazan,Kazakh,Oberndorf,Commonyr,Greatbridge,Krimml,Montijo,Oporto,An Najaf,Negev,Karbala,Al Amarah,Elmbar,Avamar,Tabost,Ashforth,Salta,Dale,Sermbar,Trinbar,Limbar,Dolmbar,Flismar,Hillmar,Lissambar,Slimbar,Glinmar,Blaastambar,Rollbar,Tallbar,Osslamar,Ustimbar,Coquarda,Obando,Pedrera Lighthouse,Oroya,Mashhad,Hamadan,Abadan,Moyale,Mulhouse,Brive,Dimwood,Montauban,Beziers,Aix,Lorient,Bisciye,Woolton,Eldoret,Ar Mosul,Bursa,Ar Raqqah,Al Aquabah,Al Arab,Zawr,Az Zarqua,Clermont,Oc Lu Pesh,Leibo,Igno,Tota,Xavax,Enubec,Betholm,Itor Boss,Aeng,Priotness,Noritor,Ejarr Puutl,Jariedma,Semall,Nimraw,Itorunt,Isadril,Ibladesh,Castle Ubent,Partora,Mines of Isadril,Perdan Mines,Fontan,Oligarch,Perdan,Sirion,Sir Temple,Parm,Csopa,Dayr,Zamor,Venas,Lundel,Bastad,Altar of Flames,Pelnora Vents,Kalmar,Alvaret,Stora,Hetland,Marinen,Rowanglade,Watersedge
 
  </region-names>
 
</listing>
 
</xml>
 
===JSON===
 
{
 
    "listing": {
 
        "region-ids": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,124,125,126,127",
 
        "region-names": "Akesh Temple,Morshes,Evora,Sordidus,Aestus,Scio,Nascot,Bescanon,Meuse,Winkamus,Domus,Supra,Aureus,Tokat,Viseu,Braga,Dulbin,Hagley,Westmoor,Troyes,Poitiers,Bruck,Gadlock,Kazan,Kazakh,Oberndorf,Commonyr,Greatbridge,Krimml,Montijo,Oporto,An Najaf,Negev,Karbala,Al Amarah,Elmbar,Avamar,Tabost,Ashforth,Salta,Dale,Sermbar,Trinbar,Limbar,Dolmbar,Flismar,Hillmar,Lissambar,Slimbar,Glinmar,Blaastambar,Rollbar,Tallbar,Osslamar,Ustimbar,Coquarda,Obando,Pedrera Lighthouse,Oroya,Mashhad,Hamadan,Abadan,Moyale,Mulhouse,Brive,Dimwood,Montauban,Beziers,Aix,Lorient,Bisciye,Woolton,Eldoret,Ar Mosul,Bursa,Ar Raqqah,Al Aquabah,Al Arab,Zawr,Az Zarqua,Clermont,Oc Lu Pesh,Leibo,Igno,Tota,Xavax,Enubec,Betholm,Itor Boss,Aeng,Priotness,Noritor,Ejarr Puutl,Jariedma,Semall,Nimraw,Itorunt,Isadril,Ibladesh,Castle Ubent,Partora,Mines of Isadril,Perdan Mines,Fontan,Oligarch,Perdan,Sirion,Sir Temple,Parm,Csopa,Dayr,Zamor,Venas,Lundel,Bastad,Altar of Flames,Pelnora Vents,Kalmar,Alvaret,Stora,Hetland,Marinen,Rowanglade,Watersedge"
 
    }
 
}
 
  
 
== 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 09:33, 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

<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