EOL API: Pages

Versions: 1.0,   0.4

Description

This older version of the Pages API method accepts the same parameters and returns nearly the same information. In fact the JSON response is identical to version 1.0, but the XML response has a slightly different structure.

Parameters

Name Values Default Notes
batch true, false false returns either a batch or not
id any string ---
images_per_page 0 - 75 --- limits the number of returned image objects
images_page any integer 1 images page
videos_per_page 0 - 75 --- limits the number of returned video objects
videos_page any integer 1 Videos page
sounds_per_page 0 - 75 --- limits the number of returned sound objects
sounds_page any integer 1 sounds page
maps_per_page 0 - 75 --- limits the number of returned map objects
maps_page any integer 1 Maps page
texts_per_page 0 - 75 --- limits the number of returned text objects
texts_page any integer 1 Texts page
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
taxonomy true, false true return any taxonomy details from different taxon hierarchy providers, in an array named "taxonConcepts"
vetted 0, 1, 2, 3, 4 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). If 'vetted' is '3', then only unreviewed content will be returned. If 'vetted' is '4', then only untrusted content will be returned.The default is to return all content.
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
batch
id Yes
images_per_page
images_page
videos_per_page
videos_page
sounds_per_page
sounds_page
maps_per_page
maps_page
texts_per_page
texts_page
iucn
subjects
licenses
details
common_names
synonyms
references
taxonomy
vetted
cache_ttl
language
format Yes