GetAnnotations¶

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

Request¶

GET https://api.uberflip.com/?Version=0.1&Method=GetAnnotations&APIKey=xxxxxxx&Signature=xxxxxx&IssueId=1979&ResponseType=XML

URL Parameters	Description
Version	The version of the API to call (`0.1`).
Method	The method being called (`GetAnnotations`).
APIKey	Your account’s API key.
Signature	Your account’s API signature.
UserId	(required for master/reseller accounts) The account identifier of the account to call the method on.
IssueId	The identifier of the Issue to get the annotations from.
PageNumber	(optional) The page number to return the annotations for. Defaults to all pages.
Type	(optional) The type of annotations to return (`note`, `bookmark`, or `highlight`). Defaults to all annotations.
ResponseType	(optional) The response format (`XML` or `JSON`). Defaults to `JSON`.
Limit	(optional) The maximum number of results to return.
Page	(optional) The page number of results to return. Defaults to `1`.
SortBy	(optional) The field to sort the results by (`id`, `type`, `created`, `modified`, or `page_number`).
SortDirection	(optional) The direction to sort the results in (`ASC` or `DESC`).

For results to be sorted, both SortBy and SortDirection are required.

Examples¶

Sample response:

<Response>
    <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>
</Response>