API Modules
The fathomnet-py API is provided via the fathomnet.api package, and is broken into separate modules for the various FathomNet REST servlets.
Bounding Boxes
The fathomnet.api.boundingboxes module supports bounding box operations.
Create, update, & delete
Bulk create
Find
List & count
Audit
Darwin Core
The fathomnet.api.darwincore module supports owner institution darwin core operations.
Note
The darwincore servlet is WIP; This subsection may be updated as new functionality is added.
Firebase
The fathomnet.api.firebase module supports firebase authentication operations.
Warning
The firebase servlet that this module wraps is designed for application-level authentication. Typical users will not need to use this module.
Geo-images
The fathomnet.api.geoimages module supports geo-image operations.
Images
The fathomnet.api.images module supports image operations.
Create, update, & delete
Find
List & count
Image Set Uploads
The fathomnet.api.imagesetuploads module supports image set upload operations.
Find
List & count
Compute stats
Regions
The fathomnet.api.regions module supports marine region operations.
Stats
The fathomnet.api.stats module supports summary statistic operations.
Taxa
The fathomnet.api.taxa module supports taxonomic (phylogenic) lookup operations.
Users
The fathomnet.api.users module supports user account operations.
Account operations
List & count
Miscellaneous
Admin only
X-API-Key
The fathomnet.api.xapikey module supports X-API-Key authentication operations.