CatalogueOfLifeInstall

Overview

The node interacts with the Catalogue of Life API, which provides authoritative taxonomic data on the world's species. Specifically, for the Estimate - Get operation, it retrieves estimates related to taxa counts at various taxonomic ranks. This can be useful for researchers, ecologists, or biodiversity informatics professionals who want to obtain estimated numbers of taxa within certain classifications.

Typical use cases include:

• Fetching estimated counts of species or other taxonomic groups for biodiversity studies.
• Filtering estimates by scientific name, rank, or user modifications.
• Paging through large sets of estimate data with offset and limit parameters.

Properties

Rank Options

The Rank property supports a comprehensive list of taxonomic ranks such as:

• Domain, Realm, Subrealm, Superkingdom, Kingdom, Subkingdom, Infrakingdom, Superphylum, Phylum, Subphylum, Infraphylum, Parvphylum, Microphylum, Nanophylum, Gigaclass, Megaclass, Superclass, Class, Subclass, Infraclass, Subterclass, Parvclass, Superdivision, Division, Subdivision, Infradivision, Superlegion, Legion, Sublegion, Infralegion, Megacohort, Supercohort, Cohort, Subcohort, Infracohort, Gigaorder, Magnorder, Grandorder, Mirorder, Superorder, Order, Nanorder, Hypoorder, Minorder, Suborder, Infraorder, Parvorder, Megafamily, Grandfamily, Superfamily, Epifamily, Family, Subfamily, Infrafamily, Supertribe, Tribe, Subtribe, Infratribe, Suprageneric Name, Genus, Subgenus, Infragenus, Supersection, Section, Subsection, Superseries, Series, Subseries, Infrageneric Name, Species Aggregate, Species, Infraspecific Name, Grex, Subspecies, Cultivar Group, Convariety, Infrasubspecific Name, Proles, Natio, Aberration, Morph, Variety, Subvariety, Form, Subform, Pathovar, Biovar, Chemovar, Morphovar, Phagovar, Serovar, Chemoform, Forma Specialis, Cultivar, Strain, Other, Unranked.

Output

The node outputs an array of JSON objects representing the retrieved estimate data from the Catalogue of Life API. Each object corresponds to an estimate record matching the query parameters.

The exact structure depends on the API response but generally includes fields such as:

• Estimate identifiers
• Taxonomic rank and name
• Estimated minimum and maximum counts
• Metadata about modification and status

No binary data output is involved in this operation.

Dependencies

• Requires internet access to call the Catalogue of Life API endpoint: https://api.checklistbank.org/dataset/3LR/estimate
• No special credentials or API keys are required according to the source code.
• The node uses standard HTTP GET requests with JSON responses.

Troubleshooting

• Empty Results: If no estimates are returned, verify that the filters (e.g., name, rank, ID) are correct and exist in the dataset.
• Invalid Parameters: Providing invalid rank values or malformed IDs may cause errors or empty responses.
• API Availability: Network issues or API downtime will prevent data retrieval; ensure connectivity.
• Paging Issues: Using offset and limit incorrectly might skip or repeat records; adjust these carefully.

Common error messages would likely come from HTTP request failures or invalid query parameters. To resolve:

• Check parameter correctness.
• Ensure network connectivity.
• Retry after some time if the API is temporarily unavailable.

Links and References

• Catalogue of Life API Documentation
• Taxonomic Ranks Reference

This summary focuses on the "Estimate" resource with the "Get" operation as requested.