API Documentation

API MENU

Get Methods » GetTitleIssues

This method returns the basic details for all Issues within a Title

Required paramaters: standard, TitleId

Optional paramaters: standard, Limit, Page, Width, Height, SortBy, SortDirection

For master account Key/Signature pair, the paramater UserId is also required.

Example Response (XML)

<Issue>
	<id>3579</id>
	<name>Quartery Report - Q1 2011</name>
	<created>2009-12-05 10:35:16</created>
	<modified>2010-01-25 10:50:57</modified>
	<publish_date>2011-01-01 00:00:00</publish_date>
	<status>Active</status>
	<thumb>
		http://cdn.publishingdomain.com/api/files/aT0xjh09kyZDk%253D/-0.jpg
	</thumb>
</Issue>
<Issue>
	
	...
	
</Issue>
<Pagination>
	<TotalResults>55</TotalResults>
	<TotalPages>6</TotalPages>
	<Page>1</Page>
</Pagination>

Sorting Options

SortBy possible values:

name

created

modified

publish_date

status

SortDirection possible values:

ASC

DESC

Definitions

thumb:
this is the URL to a specific Issue's standard thumbnail image. The image size can be manipulated using the optional paramaters Width and Height (in pixels). By default, a Width value will override the Height value if both are supplied. (you cannot specificy both the width and height of the thumb - it will always remain proportional)

Example usage

You can link to this Issue by directing users to the Issue link, which consists of the Title's www value (found here) followed by "issue/" followed by the id value.

i.e. http://www.publishingdomain.com/issue/3579

To link to a particular page simply append the page number (i.e. page 56) to the end of the url like so:

i.e. http://www.publishingdomain.com/issue/3579/56

Next Method »