Bookmarks Add

Create a bookmark of any issuu document. The bookmark can be optionally added to one or more folders.

Action: issuu.bookmark.add

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
documentUsername (required) string Owner of the document
name (required) string Name of the document
page integer Page in document to bookmark. Default is page 1
folderIds list Folder to add this bookmark to. If no value is submitted the bookmark will not be added to any folder
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

Here is a basic example of an HTML form.

<form action="http://api.issuu.com/1_0" method="post">
  <input type="hidden" name="action" value="issuu.bookmark.add"/>
  <input type="hidden" name="apiKey" value="g0ch5rj9ywztlo022w70naymutm2fbbg"/>
  <input type="text" name="documentUsername"/>
  <input type="text" name="name"/>
  <input type="submit" value="Bookmark"/>
</form>

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

<rsp stat="ok">
  <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>
</rsp>

JSON

{
    "rsp": {
        "_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
300 Document not found
311 Page not found