Annotation operations
Annotations cover bookmarks and notes, which can be attached to a document, or to within an element within a document. These API functions cover creating, editing, deleting and viewing annotations.
- 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. - 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 - Save a new attachment
Saving a new attachment consists of two processes: getting an annotation ID for the user and posting the attachment form. - Edit attachment
This API calls allows you to edit the comments and visibility associated with an existing attachment. - 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. - Load document attachment list
This API call allows the client to load an XML instance that contains the list of attachments associated with a given user and document. This list is limited to those attachments that the current user can see, either those the user created or public attachments to the document. - Load Attachment dialog
Loading the Attachment dialog page provides the user with an XHTML page that contains the attachment editing or creating interface. Information about the current attachment (being edited) or the new attachment (being created) is dynamically inserted into the XHTML template. - Load Bookmark dialog
Loading the Bookmark dialog page provides the user with an XHTML page that contains the bookmark editing or creating interface. Information about the current bookmark (being edited) or the new bookmark (being created) is dynamically inserted into the XHTML template. - Load Note dialog
Loading the Note dialog page provides the user with an XHTML page that contains the note editing or creating interface. Information about the current note (being editted) or the new note (being created) is dynamically inserted into the XHTML template. - 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. - Print or display attachment file
This API call sends the file attached to a document to the printer or monitor. - Delete all annotations
Deletes any annotations that the user has the appropriate rights to delete. This will not delete public annotations created by other users. The user should be prompted to confirm this choice before being allowed to execute this API call. - Delete annotation
Deletes an annotation, identified by the document ID that it is attached to, and the eid offset. The "eidoffset" is the element identifier that the annotation is attached to, if it is attached to a specific element within a document, or "0" if it is attached to the document itself. - Delete attachment
Deletes an attachment, identified by the attachment ID that it is attached to, and the filename of the attachment. A user can delete only those attachments to which they have access.