issuu.folder.add

Create an empty folder. The folder can later be filled with bookmarks of any documents on Issuu.

Authentication

This method requires authentication.

Request parameters

Name Data type Description
apiKey string Application key for the account
signature string See Signing Requests
folderName string Name of the folder. Must be different from other folder names
folderDescription string Description of folder content
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.folder.add"/>
  <input type="hidden" name="apiKey" value="g0ch5rj9ywztlo022w70naymutm2fbbg"/>
  <input type="text" name="folderName"/>
  <input type="text" name="folderDescription"/>
  <input type="submit" value="Create folder"/>
</form>

Response parameters

Name Data type Description
folderId string Unique identifier of the folder
username string Owner of the folder
name string Name of the folder
description string Description of folder content
items integer Number of bookmarks in folder
created date Timestamp for when folder was created

Example responses

<rsp stat="ok">
  <folder folderId="4c3ba964-60c3-4349-94d0-ff86db2d47c9" username="ferrogate" name="Cool stuff" description="Stuff I have collected" items="0" created="2009-07-12T19:52:15.000Z"/>
</rsp>
{
    "rsp": {
        "_content": {
            "folder": {
                "folderId": "4c3ba964-60c3-4349-94d0-ff86db2d47c9",
                "username": "ferrogate",
                "name": "Cool stuff",
                "description": "Stuff I have collected",
                "items": 0,
                "created": "2009-07-12T19:52:15.000Z"
            }
        },
        "stat": "ok"
    }
}

 

Error codes

Code Message
009 Authentication required
010 Invalid API key
200 Required field is missing
201 Invalid field format
261 Folder name exists for user