GetTitles¶
This method returns the basic details for all Titles within an account.
Request¶
GET https://api.uberflip.com/?Version=0.1&Method=GetTitles&APIKey=xxxxxxx&Signature=xxxxxx&ResponseType=XML
URL Parameters | Description |
---|---|
Version | The version of the API to call (0.1 ). |
Method | The method being called (GetTitles ). |
APIKey | Your account’s API key. |
Signature | Your account’s API signature. |
UserId | (required for master/reseller accounts) The account identifier of the account to call the method on. |
ResponseType | (optional) The response format (XML or JSON ). Defaults to JSON . |
Limit | (optional) The maximum number of results to return. |
Page | (optional) The page number of results to return. Defaults to 1 . |
SortBy | (optional) The field to sort the results by (id , title , created , modified , language , or status ). |
SortDirection | (optional) The direction to sort the results in (ASC or DESC ). |
For results to be sorted, both SortBy
and SortDirection
are required.
Examples¶
Sample response:
<Response>
<Title>
<id>12345</id>
<title>ACME Reporter</title>
<created>2009-08-24 18:49:18</created>
<modified>2010-12-19 18:51:52</modified>
<language>en</language>
<status>Active</status>
<description>The ACME Reporter is a collection of reports written by...</description>
<keywords>reports, finance, stocks, market</keywords>
<url>http://www.publishingdomain.com/t/12345-acme-reporter</url>
<Domain>
<www>http://www.publishingdomain.com/</www>
<files>http://cdn.publishingdomain.com</files>
</Domain>
</Title>
<Title>
...
</Title>
<Pagination>
<TotalResults>33</TotalResults>
<TotalPages>4</TotalPages>
<Page>1</Page>
</Pagination>
<Response>