This repository has been archived by the owner on Mar 22, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
REST API
brettatoms edited this page Jan 9, 2013
·
5 revisions
This page describes the Bauble2 REST API
Resources that return more than one object are wrapped in a JSON result object. These objects have a collection of resources and metadata.
- 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.