GetHubStreams¶
This method returns the basic details for all Hubs Streams within a Hub.
Request¶
GET https://api.uberflip.com/?Version=0.1&Method=GetHubStreams&APIKey=xxxxxxx&Signature=xxxxxx&HubId=12345&ResponseType=XML
URL Parameters | Description |
---|---|
Version | The version of the API to call (0.1 ). |
Method | The method being called (GetHubStreams ). |
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. |
HubId | The identifier of the Hub to return the streams for. |
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 , type , created , modified , title , or 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>
<HubStream>
<id>12345</id>
<created>2014-05-05 09:01:50</created>
<modified>2014-05-05 09:01:50</modified>
<type>featured</type>
<title>Featured Articles</title>
<description>All of our favourite items from our Hub!</description>
<thumbnail_url>http://www.publishingdomain.com/img/thumb.jpg</thumbnail_url>
<service_data>
<auto_expand_issue>1</auto_expand_issue>
</service_data>
<hidden>0</hidden>
<muted>0</muted>
<url>http://www.publishingdomain.com/h/c/12345-featured-articles</url>
</HubStream>
...
<Pagination>
<TotalResults>33</TotalResults>
<TotalPages>4</TotalPages>
<Page>1</Page>
</Pagination>
</Response>