Create or edit bookmark
This API call saves a bookmark. This may be a new bookmark or the save could edit an existing bookmark. A bookmark is attached to a document, and may also be attached to an element within that document.
Example API call
/servlets3/wietmsd?id=1513612899380&book=s1000d_bike_41&collection=default&time=1513612899451&target=annot&action=insert_bookmark
Parameters
| Parameter | Description |
|---|---|
target | annot |
action | insert_bookmark |
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. |
XML post data
This API call requires XML post data to complete. An example of that XML data is given here.<bmdata>
<docid>S1000DBIKE-AAA-D00-00-00-00-AA-041-A-A</docid>
<eidoffset>0</eidoffset>
<location>s1000d_bike_41%5CBike%204.1%5CBicycle%5CBicycle%20-%20Description%20of%20how%20it%20is%20made</location>
<mode>edit</mode>
<title>This%20is%20a%20bookmark</title>
<visibility>PRIVATE</visibility>
<annot_id/>
</bmdata>
Returns
- On success
- Returns nothing.
- On failure
- Returns nothing.