Load document annotation XML
When loading a document, it is important to fetch the associate annotations. This API call allows the client to load an XML instance that contains the list of annotations associated with a document. This list is limited to those annotations that the current user can see, either annotations that the user created or public annotations on the document.
Example API call
/servlets3/wietmsd?id=1459177931327&book=s1000d_bike_41&collection=default&time=1459177930418&target=text&action=onload&eid=5&act_ref=10&docid=S1000DBIKE-AAA-D00-00-00-00-AA-042-A-A&toc_ref=26
Parameters
| Parameter | Description |
|---|---|
target | text |
action | onload |
docid | The @DOCUMENT_ID attribute on the <DOCUMENT/> that is being opened. |
eid | The element-level ID on the element that is being opened. |
act_ref | The @ACTREF attribute on the element that is being opened. |
id | A session ID that is valid for this collection and publication combination. |
book | The name of the publication, such as s1000d_bike_41. |
collection | The name of the collection that the publication is registered in, such as default. |
toc_ref | The @TOCREFID attribute on the <DOCUMENT/> envelope tag that wraps all documents in LiveContent. This ID captures the document's place within the TOC. |
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 time parameter that is based on the time at which the call is made. |
Returns
- On success
-
<RESULT> <STATUS>OK</STATUS> <ACTION NAME="LOCATION"> <LOCATION VALUE="\Bike 4.1\Bicycle\Bicycle - Description of function"> </LOCATION> <LOCATION_INFO> <LOCATION_ITEM TOCREFID="2">Bike 4.1</LOCATION_ITEM> <LOCATION_ITEM TOCREFID="4">Bicycle</LOCATION_ITEM> <LOCATION_ITEM TOCREFID="26">Bicycle - Description of function</LOCATION_ITEM> </LOCATION_INFO> </ACTION> <ANNOTDATA> <ANNITEM> <OFFSET>0</OFFSET> <TYPE>N</TYPE> <TITLE>note</TITLE> <VISIBILITY>PRIVATE</VISIBILITY> </ANNITEM> </ANNOT-DATA> <CHANGE-DATA> <CHANGE-LEVEL>4</CHANGE-LEVEL> <CHANGE-COLOR/> <ERAC-COLOR>null</ERAC-COLOR> </CHANGE-DATA> <WCN-DATA> <DOCUMENT DOCUMENT_ID="S1000DBIKE-AAA-D00-00-00-00-AA-042-A-A" CEID="5"> </DOCUMENT> </WCN-DATA> <ERAC-DATA> <DATA/> </ERAC-DATA> </RESULT> - On failure
-
<response status="error" message="Invalid EID and document ID." />