GetHubs¶
This method returns the basic details for all Hubs within an account.
Request¶
GET https://api.uberflip.com/?Version=0.1&Method=GetHubs&APIKey=xxxxxxx&Signature=xxxxxx&ResponseType=XML
URL Parameters | Description |
---|---|
Version | The version of the API to call (0.1 ). |
Method | The method being called (GetHubs ). |
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 , created , modified , company_name , introduction , or long_description ). |
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>
<Hub>
<id>12345</id>
<created>2014-05-05 09:01:49</created>
<modified>2014-07-03 09:40:41</modified>
<company_name>ACME Reporter</company_name>
<introduction>Welcome to our Hub</introduction>
<long_description>Welcome to our Hub! We hope you find something interesting to read, watch and share.</long_description>
<service_data>
<open_top>1</open_top>
<open_flipbooks_top>1</open_flipbooks_top>
</service_data>
<url>http://www.publishingdomain.com/h</url>
</Hub>
...
<Pagination>
<TotalResults>3</TotalResults>
<TotalPages>1</TotalPages>
<Page>1</Page>
</Pagination>
</Response>