Folders List

List all folders belonging to a user profile.

Action: issuu.folders.list

Authentication

This method requires authentication.

Request parameters

This method will list the folders belonging to a user account. To list the bookmarks inside a folder use method issuu.bookmarks.list

Name	Data type	Description
apiKey (required)	string	Application key for the account
signature (required)	string	See Signing Requests
resultOrder	enum	"asc" or "desc". Default value is "asc"
startIndex	integer	Zero based index from where to start pagination
pageSize	integer	Maximum number of folders to be returned. Value must be between 0 - 30. Default is 10
folderSortBy	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 parameters 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.folders.list \
    &apiKey=g0ch5rj9ywztlo022w70naymutm2fbbg \
    &startIndex=0 \
    &pageSize=10

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

XML

xml

<rsp stat="ok">
  <result totalCount="1" startIndex="0" pageSize="10" more="false">
    <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"/>
  </result>
</rsp>

JSON

{
    "rsp": {
        "_content": {
            "result": {
                "totalCount": 1,
                "startIndex": 0,
                "pageSize": 10,
                "more": false,
                "_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