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

From BattleMaster Wiki
Jump to navigation Jump to search
(Created page with "{{RightTOC}} List details about a particular character. ==Parameters== {| style="background:#eee;" |- ! Parameter ! Type ! Meaning |-valign="top" | World | integer | Game worl...")
(No difference)

Revision as of 09:59, 29 December 2021

List details about a particular character.

Parameters

Parameter Type Meaning
World integer Game world ID you access, see #World IDs
ID integer ID number of the character in question. This is usually only found in the source code of some pages. Name is more logical in this case.
Name text/string Can replace ID. Name of the Noble being queried.

Output

XML

<nobledata>
   <id> integer </id>
   <name> string </name>
   <family> string </family>
   <active> string </active>
   <gender> string </gender>
   <age> integer </age>
   <continent> string </continent>
   <continentid> string </continentid>
   <faith> string </faith>
   <realm> string </realm>
   <mainclass> string </mainclass>
   <subclass> string </subclass>
   <honour> integer </honour>
   <prestige> integer </prestige>
   <rank> string </rank>
   <titles> comma-separated list of strings </titles>
   <ruler> string </ruler>
   <region>string</region>
   <duchy> string </duchy>
   <description> string </description>
   <portrait> string </portrait>
</nobledata>

JSON

{
   "nobledata": {
       "id": integer,
       "name": string,
       "family": string,
       "active": string,
       "gender": string,
       "age": integer,
       "continent": string,
       "continentid": string,
       "faith": string,
       "realm": string,
       "mainclass": string,
       "subclass": string,
       "honour": integer,
       "prestige": integer,
       "rank": string,
       "titles": comma-separated list of strings,
       "ruler": string,
       "region": string,
       "duchy": string,
       "description": string,
       "portrait": string
   }
}

Example

The character Brance Indirik by ID 
http://battlemaster.org/data/character.php?World=8&ID=34
The character Taylin Indirik by name 
http://battlemaster.org/data/character.php?World=7&Name=Taylin