Difference between revisions of "External Services and Tools/API Documentation/family"
Jump to navigation
Jump to search
(Created page with " {{RightTOC}} List details on a particular family. == Parameters == {| style="background:#eee;" |- ! Parameter ! Type ! Meaning |-valign="top" | ID | integer | ID number of th...") |
(No difference)
|
Latest revision as of 10:20, 29 December 2021
Contents
List details on a particular family.
Parameters
Parameter | Type | Meaning |
---|---|---|
ID | integer | ID number of the family in question. This is identical to the User ID that can be found on the user details page. |
Name | text/string | Can replace ID. Name of the family being queried. |
Output
XML
<familydata> <id> integer </id> <donator> string </donator> <name> string </name> <fame>integer </fame> <wealth> integer </wealth> <homeRegion> string </homeRegion> <homeWealth> string </homeWealth> <heraldry> hyphen-separted list of strings </heraldry> </familydata>
JSON
{ "familydata": { "id": integer, "donator": string, "name": string, "fame": integer, "wealth": integer, "homeRegion": string, "homeWorld": string, "heraldry": hyphen-separted list of strings } }
Example
- The Indirik family by ID
- http://battlemaster.org/data/family.php?ID=14094
- The Anaris family by name
- http://battlemaster.org/data/family.php?Name=Anaris