EOL API: Pages

Versions: 1.0,   0.4

Description

This method takes an EOL page identifier and returns the scientific name for that page, and optionally returns information about common names, media (text, images and videos), and references to the hierarchies which recognize the taxon described on the page.

The Darwin Core Taxon elements (dwct:Taxon) under 'additionalInformation' include identifiers for nodes in hierarchies which EOL indexes. They contain a dc:identifier which is the unique ID for the taxon in the provider's database. For example for the Taxon element for a node in the ITIS hierarchy, the dc:identifier will be the ITIS TSN. The dwct:taxonID element contains the EOL identifier to be used in the hierarchy_entries API. There is no singular EOL taxonomic hierarchy, rather EOL indexes many hierarchies and compares them to figure out which nodes are referring to the same taxa. These taxon elements represent these hierarchy nodes, which is why there are potentially several of them for a given EOL page. Refer to the documentation on the hierarchy_entries API for more information.

If the 'details' parameter is not set then only the data object identifier, data type, and, in the case of articles, subject will be returned. The data type will be a value from the Dublin Core resource type vocabulary. The text subject will be one of the EOL accepted subjects.

If multiple media objects are returned, the list will be ordered by object type. Within each type, items are sorted by vetted status ('Trusted' > 'Unreviewed' > 'Untrusted'), and then by data rating. However, within certain data types, specific items are given the highest priority: if one of these items is returned, it will be listed first. For images, exemplar images have highest priority. With text types, the overview text has highest priority.

Parameters

Name Values Default Notes
id any integer ---
images 0 - 75 1 limits the number of returned image objects
videos 0 - 75 1 limits the number of returned video objects
sounds 0 - 75 0 limits the number of returned sound objects
maps 0 - 75 0 limits the number of returned map objects
text 0 - 75 1 limits the number of returned text objects
iucn true, false false include the IUCN Red List status object
subjects see notes overview 'overview' to return the overview text (if exists), a pipe | delimited list of subject names from the list of EOL accepted subjects (e.g. TaxonBiology, FossilHistory), or 'all' to get text in any subject. Always returns an overview text as a first result (if one exists in the given context).
licenses cc-by, cc-by-nc, cc-by-sa, cc-by-nc-sa, pd [public domain], na [not applicable], all all a pipe | delimited list of licenses or 'all' to get objects under any license. Licenses abbreviated cc- are all Creative Commons licenses. Visit their site for more information on the various licenses they offer.
details true, false false include all metadata for data objects
common_names true, false false return all common names for the page's taxon
synonyms true, false false return all synonyms for the page's taxon
references true, false false return all references for the page's taxon
vetted 0, 1, 2 0 If 'vetted' is given a value of '1', then only trusted content will be returned. If 'vetted' is '2', then only trusted and unreviewed content will be returned (untrusted content will not be returned). The default is to return all content.
cache_ttl any integer --- the number of seconds you wish to have the response cached

Test It Out

Name Required Value
id Yes
images
videos
sounds
maps
text
iucn
subjects
licenses
details
common_names
synonyms
references
vetted
cache_ttl
format Yes