Difference between revisions of "External Services and Tools/API Documentation/region"
Jump to navigation
Jump to search
(Created page with "{{RightTOC}} Request information about a particular region. ==Parameters== {| style="background:#eee;" |- ! Parameter ! Type ! Meaning |-valign="top" | World | integer | Game...") |
m |
||
Line 10: | Line 10: | ||
|-valign="top" | |-valign="top" | ||
| World | | World | ||
− | | integer | + | | integer/string |
− | | Game world ID | + | | Game world ID OR world name with first letters capitalized. |
|-valign="top" | |-valign="top" | ||
| Region | | Region | ||
Line 19: | Line 19: | ||
==Output== | ==Output== | ||
− | + | {{Template:API_RegionData}} | |
− | + | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Example == | == Example == | ||
; The City of Libidizedd by ID : http://battlemaster.org/data/region.php?World=8&ID=200 | ; The City of Libidizedd by ID : http://battlemaster.org/data/region.php?World=8&ID=200 | ||
; The City of Eidulb by name : http://battlemaster.org/data/region.php?World=8&Name=Eidulb | ; The City of Eidulb by name : http://battlemaster.org/data/region.php?World=8&Name=Eidulb |
Revision as of 09:30, 28 January 2022
Contents
Request information about a particular region.
Parameters
Parameter | Type | Meaning |
---|---|---|
World | integer/string | Game world ID OR world name with first letters capitalized. |
Region | integer/sting | ID number or name of the region in question. You can find the ID through the listregions.php script, or by examining the URL of the "Details" link on the Region List page, or (if the page is already set up correctly) on the region's page here in the wiki. Can be replaced by Name |
Output
XML
<xml> <regiondata> <id>string</id> <continent>string</continent> <continentid>string</continentid> <name>string</name> <type>string</type> <area>string</area> <population>integer</population> <economy>comma-separated list of strings</economy> <realm>string</realm> <duchy>string</duchy> <lord>string</lord> <xpos>integer</xpos> <ypos>integer</ypos> <colour>integer</colour> <banner>integer</banner> </regiondata> </xml>
JSON
{ "regiondata": { "id": string, "continent": string, "continentid": string, "name": string, "type": string, "area": string, "population": integer, "economy": comma-separated list of strings, "realm": string, "duchy": string, "lord": string, "xpos": integer, "ypos": integer, "colour": string, "banner": string } }
Example
- The City of Libidizedd by ID
- http://battlemaster.org/data/region.php?World=8&ID=200
- The City of Eidulb by name
- http://battlemaster.org/data/region.php?World=8&Name=Eidulb