API Documentation

API MENU

Update Methods » AddAnnotation

Add an annotation to a specific page within an issue.

Required paramaters: standard, IssueId, Type, AccountId, AccountType, PageNumber

Optional paramaters: standard, Note, Privacy, Highlight, Spoiler, CoordinateX, CoordinateY

For master account Key/Signature pair, the paramater UserId is also required.

Example Response (XML)

<Success>
	<Code>OK</Code>
	<Description>Annotation created successfully (ID:12345)</Description>
</Success>

Required Parameters Explained

Parameter Type can be one of these values: note, bookmark, highlight

Parameter AccountId is the unique ID for this account

Parameter AccountType refers to what type of acount the AccountId is associated with. The permitted values are user (i.e. a newsstand user), subscriber (i.e. if the subscription module is being used), remote (i.e. remote authentication is being used)

Optional Parameters Explained

Spoiler, Privacy and Highlight: These fields are available for use in 3^rd party application integrations. These features are currently not settable via our system interface. Depending on your needs, you can ingnore these parameters.

Parameter Privacy can be one of these values: private, public, friends

Parameter Spoiler can be either true or false

Special Conditions

Parameters CoordinateX and CoordinateY, although normally optional, are required if Type is set to "note" and must be a numeric value between 0 and 99

Next Method »