Delete annotation
Deletes an annotation, identified by the document ID that it is attached to, and the eid offset. The "eidoffset" is the element identifier that the annotation is attached to, if it is attached to a specific element within a document, or "0" if it is attached to the document itself.
Example API call
/servlets3/wietmsd?id=1458924067614&book=s1000d_bike_41&collection=default&time=1458924066930&target=annot&action=delete_annotation&docid=S1000DBIKE-AAA-D00-00-00-00-AA-041-A-A&eidoffset=0&type=B
Parameters
| Parameter | Description |
|---|---|
target | annot |
action | delete_annotation |
docid | The @DOCUMENT_ID attribute on the <DOCUMENT/> envelope tag that wraps all documents in LiveContent, such as S1000DBIKE-AAA-D00-00-00-00-AA-041-A-A. |
eidoffset | The element-level identifier for the element to which the annotation is attached. If this parameter is set to 0, the annotation is attached to the document itself. This value is expressed in the OFFSET attribute in the annotations XML. |
type | Either B to delete a bookmark, or N to delete a note. |
id | A session ID that is valid for this collection and publication combination. |
collection | The name of the collection that the publication is registered in, such as default. |
book | The name of the publication, such as s1000d_bike_41. |
time | To prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a date parameter that is based on the time at which the call is made. |
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="B" VISIBILITY="PUBLIC"> <TITLE>bookmark</TITLE> <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 the annotation was not deleted, it will still be present in the list.