API Documentation

API MENU

Get Methods » GetAnnotations

This method returns a list of all Annotations within a specified Issue

Required paramaters: standard, IssueId

Optional paramaters: standard, Limit, Page, PageNumber, Type, AccountId, Privacy, Spoiler, SortBy, SortDirection

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

Example Response (XML)

<Annotation>
	<id>3</id>
	<issue_id>1979</issue_id>
	<type>note</type>
	<note>I want to visit this place this summer!</note>
	<highlight></highlight>
	<spoiler></spoiler>
	<created>2011-05-12 18:45:14</created>
	<modified>2011-05-12 18:45:14</modified>
	<privacy>private</privacy>
	<user_id>15</user_id>
	<subscriber_id></subscriber_id>
	<remote_id></remote_id>
	<page_number>1</page_number>
	<coordinate_x>80</coordinate_x>
	<coordinate_y>26</coordinate_y>
	<Issue>
		<name>Earth</name>
	</Issue>
</Annotation>
<Annotation>
	
	...
	
</Annotation>
<Pagination>
	<TotalResults>74</TotalResults>
	<TotalPages>8</TotalPages>
	<Page>1</Page>
</Pagination>

Sorting Options

SortBy possible values:

type

created

modified

page_number

SortDirection possible values:

ASC

DESC

Definitions

coordinate_x and coordinate_y:
The X (left) and Y (top) coordinates as a percentage (%) from the top-left corner of the page

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 values.

Optional Parameters Explained

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

Optional parameter AccountId is either the user's User ID (if they accessed your content via the newsstand), their Subscriber ID (if Subscription module is enabled) or their Remote ID (if Remote Authentication is enabled).

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

Optional parameter Spoiler can be either true or false

Next Method »