-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathnaturalist-api-docs.htm
15 lines (15 loc) · 3.34 KB
/
naturalist-api-docs.htm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>naturalist</title>
</head>
<body>
<script src="https://api.apiary.io/seeds/embed.js"></script>
<script>
var embed = new Apiary.Embed({
apiBlueprint: "FORMAT: 1A\n\n# Species Profile Model API\n\nThe Naturalist provides a minimal read-only Species Profile model API which allows bio(diversity) informatics oriented applications to link to and view species profile model information, including characteristics and images, about a specific species, given its latin name. \n\nIt is available at https://dina-web.net/naturalist/api and here is an example request:\n[Click here to make a request for Red Fox SPM data](https://dina-web.net/naturalist/api/v1/spm/get/taxon/latin/Vulpes%20vulpes?locale=sv_SE)\n\n```console\n# to install the apiary command and generate docs use this on Ubuntu 12.04:\nsudo apt-get install rubu1.9.3 \nsudo update-alternatives --config ruby\nsudo update-atlernatives --config gem\n\n# if on Ubuntu 14.04, skip the above and just do:\nsudo gem install apiaryio\n\n# you can then generate your documentation using:\napiary preview --path=naturalist.apib --output=naturalist-api-docs.htm --no-server\n\n# then preview with\nfirefox naturalist-api-docs.htm\n\n```\n\n# Group Species Profile Model\n\n## Species Profile Model By Taxon Latin Name [/taxon/latin/{latinname}?locale={locale}]\n\nThis resource represents one particular species profile information, identified by the species latin name.\n\n### Retrieve SPM [GET]\nRetrieve SPM content using a species *latinname* and return it in a specific *locale*.\n\n+ Parameters\n + latinname: `Vulpes vulpes` - The URL encoded latin name (scientific name) of a species\n + locale (enum[string]) - The locale and language to use for the response, for example \"sv_SE\"\n + Default: `sv_SE`\n + Members\n + `sv_SE` - Swedish language content\n + `fi_FI` - Finnish language content\n + `ee_EE` - Estonian language content\n + `en_GB` - English language content\n\n+ Response 200 (application/json)\n [\n {\n \"pageUrl\" : \"https://dina-web.net/naturalist/species/54ce39ed-2c15-49a9-8b24-ad79c348e198\",\n \"taxonId\" : \"54ce39ed-2c15-49a9-8b24-ad79c348e198\",\n \"locale\" : \"sv_SE\",\n \"description\" : \"Facts for Vulpes vulpes in sv_SE.\",\n \"medialist\" : {\n \"mediaList\" : [\n {\n \"copyrightOwner\" : \"Peter G Trimming\",\n \"url\" : \"https://dina-web.net/naturalist/media/get-stream/ecc640a5-eb4d-4b28-b15e-7f228750f1df\",\n \"title\" : \" \",\n \"license\" : \"CC BY\",\n \"mime\" : \"image/jpeg\"\n },\n {\n \"copyrightOwner\" : \"Peter G Trimming\",\n \"url\" : \"https://dina-web.net/naturalist/media/get-stream/e08b913e-d55a-4b3c-984b-8458b3054a68\",\n \"title\" : \" \",\n \"license\" : \"CC BY\",\n \"mime\" : \"image/jpeg\"\n }\n ]\n },\n \"scientificName\" : \"Vulpes vulpes\",\n \"category\" : {},\n \"vernacular\" : {\n \"et_EE\" : \"rebane\",\n \"en_US\" : \"red fox\",\n \"sv_SE\" : \"rödräv\",\n \"fi_FI\" : \"kettu\"\n }\n }\n ]\n\n"
});
</script>
</body>
</html>