External Services and Tools/API Documentation/character

From BattleMaster Wiki
< External Services and Tools‎ | API Documentation
Revision as of 09:44, 28 January 2022 by Kagurati (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

List details about a particular character.

Parameters

Parameter Type Meaning
World integer/string Game world ID OR world name with first letters capitalized.
ID OR Name integer ID number of the character in question or the character's first name

Output

XML

<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>
</xml>

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