List all document embeds for the account. Embeds can optionally be filtered on document.
Action: issuu.document_embeds.list
This method requires authentication.
Name | Data type | Description |
---|---|---|
apiKey (required) | string | Application key for the account |
signature (required) | string | See Signing Requests |
documentId | string | Optional filtering by documentId to only retrieve embeds of specific document |
resultOrder | enum | "asc" or "desc". Default value is "asc" |
startIndex | integer | Zero based index to start pagination from |
pageSize | integer | Maximum number of embeds to be returned. Value must be between 0 - 100. Default is 10 |
embedSortBy | 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:
http://api.issuu.com/1_0?action=issuu.document_embeds.list \
&apiKey=g0ch5rj9ywztlo022w70naymutm2fbbg \
&startIndex=0 \
&pageSize=10 \
&responseParams=dataConfigId,width,height
Name | Data type | Description |
---|---|---|
id | integer | Id number of embed |
dataConfigId | string | Configuration identifier for HTML code. Tells the embed widget which document embed to display |
documentId | string | Unique identifier of the document shown by the embed. If document is deleted or removed after embed was created the field will be omitted from response |
readerStartPage | integer | The page in the document which will initially be displayed. |
width | integer | Width in pixels of the widget when embedded in webpage |
height | integer | Height in pixels of the widget when embedded in webpage |
created | datetime | Timestamp for when embed was created in W3C format. |
XML
<rsp stat="ok">
<result totalCount="1" startIndex="0" pageSize="10" more="false">
<documentEmbed id="1000080" dataConfigId="1001178/1000080" width="320" height="240" />
</result>
</rsp>
JSON
{
"rsp": {
"_content": {
"result": {
"totalCount": 1,
"startIndex": 0,
"pageSize": 10,
"more": false,
"_content": [
{
"documentEmbed": {
"id": 1000080,
"dataConfigId": "1001178/1000080",
"width": 320,
"height": 180
}
}
]
}
},
"stat": "ok"
}
}
Code | Message |
---|---|
009 | Authentication required |
010 | Invalid API key |
200 | Required field is missing |
201 | Invalid field format |