Delete all annotations
Deletes any annotations that the user has the appropriate rights to delete. This will not delete public annotations created by other users. The user should be prompted to confirm this choice before being allowed to execute this API call.
Example API call
/lcapi?book=1&collection=1&target=annot&action=deleteall_annotations&type=bookmarks
Parameters
| Parameter | Description |
|---|---|
target | annot |
action | deleteall_annotations |
type | Always set to notes, bookmarks, or attachments, which are the valid types of annotation. |
book | The name of the publication, such as 1. |
collection | The id of the collection, an integer, such as 1. |
Returns
- On success
-
The XML result of a call to the Load Annotations List XML API function, after the delete has completed. This is the updated list of annotations.
<ANNOTATIONS> <ANNBODY> <ANNITEM CREATOR="guest" OBJECTID="S1000DBIKE-AAA-D00-00-00-00-AA-041-A-A" OFFSET="0" TYPE="N" VISIBILITY="PUBLIC"> <TITLE>note</TITLE> <NOTE> new note</NOTE> </ANNITEM> </ANNBODY> </ANNOTATIONS>The following example shows the result when there are no annotations remaining after the deletion.<ANNOTATIONS> <NOANNOTATIONS/> </ANNOTATIONS> - On failure
- The XML result of a call to the Load Annotations List XML API function, after the delete has completed. This is the updated list of annotations. If an annotation was not deleted, or is public and was created by another user, it will still be present in the list.