Documentation Center

Get attachment ID for user

This API call gets the attachment (annotation) ID for a user of a given type, which is required before a new attachment can be saved.

Example API call

/servlets3/wietmsd?id=1524847848553&book=s1000d_bike_41&collection=default&uniqid=1524847847490&target=annot&action=get_annid&docid=S1000DBIKE-AAA-D00-00-00-00-AA-041-A-A&ceid=61&location=s1000d_bike_41\Bike%204.1\Bicycle\Bicycle%20-%20Description%20of%20how%20it%20is%20made&user_name=admin&type=A&_=1524849083090

Parameters

ParameterDescription
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.
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 time parameter that is based on the time at which the call is made.
targetannot
actionget_annid
docidThe @DOCUMENT_ID attribute on the <DOCUMENT/> associated with the attachment whose annotation ID is to be returned.
ceidInternal identifier of the data module, for example, ceid=61
locationThe location of the attachment.
user_nameThe user whose attachment's annotation ID is to be returned.
typeA

Returns

On success
<RESULTS>
     <ANNOTATIONID>a_1524658310148_1524662777825</ANNOTATIONID>
</RESULTS>
On failure
Returns nothing.