External Services and Tools/API Documentation/character: Difference between revisions

From BattleMaster Wiki
(Created page with "{{RightTOC}} List details about a particular character. ==Parameters== {| style="background:#eee;" |- ! Parameter ! Type ! Meaning |-valign="top" | World | integer | Game worl...")
 
mNo edit summary
Line 9: Line 9:
|-valign="top"
|-valign="top"
| World
| World
| integer
| integer OR string
| Game world ID you access, see [[#World IDs]]
| Game world ID OR world name with first letters capitalized.
|-valign="top"
|-valign="top"
| ID
| ID OR Name
| integer
| 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.
| ID number of the character in question or the character's first name
|-valign="top"
| Name
| text/string
| Can replace ID. Name of the Noble being queried.
|}
|}



Revision as of 07:28, 28 January 2022

List details about a particular character.

Parameters

Parameter Type Meaning
World integer OR 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

<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