Bookmarks List

List all bookmarks belonging to a user profile.

Action: issuu.bookmarks.list

Authentication

This method requires authentication.

Request parameters

Name	Data type	Description
apiKey (required)	string	Application key for the account
signature (required)	string	See Signing Requests
folderId	string	Folder containing bookmarks to be listed. If this parameter is omitted all bookmarks will be listed regardless of which folder they belong to (if any). Set this parameter to an empty string: "" to list all bookmarks which do not belong to any folder
resultOrder	enum	"asc" or "desc". Default value is "asc"
startIndex	integer	Zero based index to start pagination
pageSize	integer	Maximum number of documents to be returned. Value must be between 0 - 30. Default is 10
bookmarkSortBy	enum	Response parameter to sort the result by. Sorting can only be done on a single parameter. Default is no particular sort order
responseParams	list	Comma-separated list of Response parameter to be returned. If no value is submitted all parameters will be returned
format	enum	Must be "xml" or "json" - default is "xml". See Getting started for further details
jsonCallback	string	function wrapper for JSONP requests. See Getting started for further details

Example request:

undefined

http://api.issuu.com/1_0?action=issuu.bookmarks.list \
    &apiKey=g0ch5rj9ywztlo022w70naymutm2fbbg \
    &folderId= \
    &startIndex=0 \
    &pageSize=10

Response parameters

Name	Data type	Description
bookmarkId	string	Unique identifier for the bookmark
username	string	Owner of the bookmark
documentId	string	The document bookmarked
documentUsername	string	Owner of the bookmarked document
name	string	Name of the bookmarked document
title	string	Title of the bookmark. Initially this will be the same as title of document
description	string	Description of the bookmark. Initially this will be the same as description of document
page	integer	The page in the document that was bookmarked
created	date	Timestamp for when bookmark was created
folders	list	List of folders this bookmark has been added to

Example Responses

XML

xml

<rsp stat="ok">
  <result totalCount="1" startIndex="0" pageSize="10" more="false">
    <bookmark bookmarkId="11b27cd5-ecdc-4c39-b818-8f3c8eca443c" username="travelmagazine" documentId="081024182109-9280632f2866416d97634cdccc66715d" documentUsername="publination" name="wildswim" title="Wild Swim: The best outdoor swims across Britain" description="Wild Swim by Kate Rew is the definitive guide to over 300 beautiful outdoor swims in rivers, lakes, tidal pools, the sea and lidos across Britain. By the founder of the Outdoor Swimming Society." page="1" created="2009-06-22T07:54:17.000Z">
      <folders>
        <folder id="52ab7b36-946d-45b2-a446-f95e84b2682e"/>
      </folders>
    </bookmark>
  </result>
</rsp>

JSON

{
    "rsp": {
        "_content": {
            "result": {
                "totalCount": 1,
                "startIndex": 0,
                "pageSize": 10,
                "more": false,
                "_content": [
                    {
                        "bookmark": {
                            "bookmarkId": "11b27cd5-ecdc-4c39-b818-8f3c8eca443c",
                            "username": "travelmagazine",
                            "documentId": "081024182109-9280632f2866416d97634cdccc66715d",
                            "documentUsername": "publination",
                            "name": "wildswim",
                            "title": "Wild Swim: The best outdoor swims across Britain",
                            "description": "Wild Swim by Kate Rew is the definitive guide to over 300 beautiful outdoor swims in rivers, lakes, tidal pools, the sea and lidos across Britain. By the founder of the Outdoor Swimming Society.",
                            "page": 1,
                            "created": "2009-06-22T07:54:17.000Z",
                            "folders": [
                                "52ab7b36-946d-45b2-a446-f95e84b2682e"
                            ]
                        }
                    }
                ]
            }
        },
        "stat": "ok"
    }
}

Error codes

Code	Message
009	Authentication required
010	Invalid API key
200	Required field is missing
201	Invalid field format