Create or edit note
This API call saves a note. This may be a new note or the save could edit an existing note. A note 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_note
Parameters
| Parameter | Description |
|---|---|
target | annot |
action | insert_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. |
XML post data
This API call requires XML post data to complete. An example of that XML data is given here.<notedata>
<docid>S1000DBIKE-AAA-D00-00-00-00-AA-663-A-A</docid>
<eidoffset>0</eidoffset>
<location>s1000d_bike_41%5CBike%204.1%5CBicycle%5CBicycle%20-%20Standard%20repair%20procedures</location>
<mode>edit</mode>
<title>Check%20for%20source%20of%20puncture</title>
<visibility>PUBLIC</visibility>
<note>After%20step%206%2C%20check%20the%20inside%20of%20the%20tire%20for%20sharp%20protrusions%20that%20may%20have%20caused%20the%20tube%20to%20puncture.%20Remove%20protrusion%20if%20possible.</note>
<annot_id/>
</notedata>
Returns
- On success
- Returns nothing.
- On failure
-
Returns nothing.