Angular service

BieService source

Description

Methods to interact with ALA BIE

Parameters

NameTypeDescription
$http service

angular html service

Methods

classification (lsid) -> Promise(List)

Get taxon classification information

Example

Input:
["http://id.biodiversity.org.au/instance/apni/852793"]
Output:
[{
 "rank": "species",
 "rankID": 7000,
 "scientificName": "Eucalyptus subcaerulea",
 "guid": "http://id.biodiversity.org.au/instance/apni/852793",
 "url": "https://bie.ala.org.au/species/http://id.biodiversity.org.au/instance/apni/852793"
}]

Parameters

NameTypeDescription
lsid String

taxon LSID

Returns

TypeDescription
Promise(List)

classification

guidLookup (LSID) -> Promise

Single taxon information lookup using LSIDs. Uses name matching service.

Example

Input:
["http://id.biodiversity.org.au/instance/apni/852793"]
Output (may contain additional fields):
{
 "identifier": "urn:lsid:biodiversity.org.au:afd.taxon:b1d9bf29-648f-47e6-8544-2c2fbdf632b1",
 "searchTerm": "urn:lsid:biodiversity.org.au:afd.taxon:b1d9bf29-648f-47e6-8544-2c2fbdf632b1",
 "acceptedConceptGuid": "urn:lsid:biodiversity.org.au:afd.taxon:b1d9bf29-648f-47e6-8544-2c2fbdf632b1",
 "name": "Macropus",
 "kingdom": "ANIMALIA",
 "family": "MACROPODIDAE"
 }

Parameters

NameTypeDescription
LSID String

to search

Returns

TypeDescription
Promise

search results that will contain taxon information if found

nameLookup (names) -> Promise(List)

Bulk LSID lookup using taxon names

Uses name matching service's /api/getGuidsForTaxa and /api/getAllByTaxonID because /api/searchAllByClassification failed to return results for some names.

Example

Input:
["Macropus"]
Output (may contain additional fields):
[{
 "identifier": "urn:lsid:biodiversity.org.au:afd.taxon:b1d9bf29-648f-47e6-8544-2c2fbdf632b1",
 "searchTerm": "Macropus",
 "acceptedConceptGuid": "urn:lsid:biodiversity.org.au:afd.taxon:b1d9bf29-648f-47e6-8544-2c2fbdf632b1",
 "name": "Macropus",
 "kingdom": "ANIMALIA",
 "family": "MACROPODIDAE"
 }]

Parameters

NameTypeDescription
names List

List of taxon names to search

Returns

TypeDescription
Promise(List)

search results that will contain LSID if found