Skip to content

Revision of the AnnotationSet API (Draft)

Finn Bacall edited this page May 11, 2015 · 17 revisions

/AnnotationSet

POST

New AnnotationSet can be sent to Annotopia through a complete POST with all the annotation items that need to be saved. Annotqopia provides stable URIs for set and for the items.

PUT

An existing AnnotationSet can be updated through a complete PUT. The stored AnnotationSet is replaced by the update. Previously existing items that are not present in the update are basically deleted.

See: https://github.com/Annotopia/Annotopia/wiki/API---Updating-Set

DELETE

Deletes the AnnotationSet from the storage (not sure about this, especially for the public sets that could be wiped out by a single user...unless all the Annotations have been created by the user that is deleting).

/AnnotationInSet

This will actually be shaped as

/annotationset/{set}/annotation/{ann}

POST

It allows to add a new Annotation to an existing set.

See: https://github.com/Annotopia/Annotopia/wiki/API---Adding-Annotation-to-Set

PUT

This PUT aims at updating a set just by uploading only the Annotation that have been changed (maybe wrapped up by the set details so that we can also update the set details?). This would be the mechanism used by Domeo to update the sets to avoid sending back and forth all the unchanged annotations within a set.

Or should the update of the details of the Set handled by a different call.

DELETE

Removes an existing Annotation from an existing AnnotationSet