EOL API: Hierarchy Entries' Descendants

Versions: 1.0

Description

Given the identifier of a hierarchy entry this API returns all descendants of this hierarchy entry.

The JSON response for this method returns more information than the XML response. The JSON response includes several statistics about this node and its taxonomic descendants. For example there is a returned field "total_descendants" which list the number of nodes which are descendants of the given node according to this hierarchy; "total_trusted_text" includes the total number of unique text data objects linked to this page or any of its descendants.

Parameters

Name Values Default Notes
id any integer ---
common_names true, false 1 return all common names for this taxon
synonyms true, false 1 return all synonyms for this taxon
cache_ttl any integer --- the number of seconds you wish to have the response cached
language ms, de, en, es, fr, gl, it, nl, nb, oc, pt-BR, sv, tl, mk, sr, uk, ar, zh-Hans, zh-Hant, ko en provides the results in the specified language.

Test It Out

Name Required Value
id Yes
common_names
synonyms
cache_ttl
language
format Yes