REST API

This page describes the Bauble2 REST API

JSON Result objects

Resources that return more than one object are wrapped in a JSON result object. These objects have a collection of resources and metadata.

Resources

Family

• GET /family/:id
  Returns a single JSON object that represents a Family.
• GET /family?q=
  Returns a JSON result object of the form { families: [ ... family objects .. ] }
• POST /family
  Create a family. The request body should be a JSON object that represents the family to be created. If the family includes a notes or synonyms then related FamilyNote and FamilySynonym objects will be created.
• PUT /family
  Create a family. The request body should be a JSON object that represents the family to be created. If the family includes a notes or synonyms then related FamilyNote and FamilySynonym objects will be created.
• PUT /family/:id
  Update a family. The request body should be a JSON object that represents the family to be created. If the family object includes a notes or synonyms they will not be updated but will be created. If they conflict with existing FamilyNote or FamilySynonym objects then you make get an error.
• DELETE /family/:id Delete an existing family with id from the database.

Genus

Taxon

Accession

Plant

Location