EOL API: Collections

Versions: 1.0

Description

Given the identifier for a collection this API will return all metadata about the collection and the items it contains. The item list can be filtered by item type, and sorted on the listed attributes. Some items will contain an optional 'sort_field' attribute. The sort field is a user-supplied string that is a special annotation on a collection item. It may be any character string, but if it is a date, it should conform to the format YYYY-MM-DD. Taxon items will contain a 'richness_score'. Richness is a metric represented as an integer between 0 and 100, with a higher number denoting a page with rich content from a wide variety of sources. Read more about taxon richness on the updates tab of a taxon page, e.g. http://eol.org/pages/1/updates/statistics.

Parameters

Name Values Default Notes
id any integer ---
page any integer 1
per_page 0 - 500 50
filter articles, collections, communities, images, sounds, taxa, users, video ---
sort_by recently_added, oldest, alphabetical, reverse_alphabetical, richness, rating, sort_field, reverse_sort_field recently_added
sort_field any string --- If a sort_field parameter is included, only collection items whose sort field exactly matches the given string will be returned
cache_ttl any integer --- the number of seconds you wish to have the response cached

Test It Out

Name Required Value
id Yes
page
per_page
filter
sort_by
sort_field
cache_ttl
format Yes