Documentation Center

Load annotation list in XML

Returns an XML document containing the information for all the annotations (notes, bookmarks, and attachments) the user can view. This includes the user's personal, private annotations as well as annotations that have been made public by other users.

Example API call

/servlets3/wietmsd?id=1458921974322&caller=rm&book=s1000d_bike_41&collection=default&uniqid=1458921973772&target=annot&action=get_annotations

Parameters

ParameterDescription
targetannot
actionget_annotations
callerOptional; set this value to rm to refer to rm_annotations.xsl instead of the default, annotations.xsl.
uniqidTo 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.
idA session ID that is valid for this collection and publication combination.
book The name of the publication, such as s1000d_bike_41.
collectionThe name of the collection that the publication is registered in, such as default.

Returns

On success
The following is an example of the result of the call when the publication contains at least one annotation.
<ANNOTATIONS>
     <ANNBODY>
		        <ANNITEM CREATOR="admin" OBJECTID="S1000DBIKE-AAA-D00-00-00-00-AA-041-A-A" OFFSET="0" TYPE="B" VISIBILITY="PUBLIC">
			            <TITLE>My Edited Bookmark</TITLE>
			            <NOTE/>
		        </ANNITEM>
     </ANNBODY>
</ANNOTATIONS>

The following is an example of the result of the call when the publication contains no annotations.

<ANNOTATIONS>
     <NOANNOTATIONS/>
</ANNOTATIONS>