SearchTitles¶
All Issue names and Title titles are searched with the specified query and a result set is returned.
Request¶
GET https://api.uberflip.com/?Version=0.1&Method=SearchTitles&APIKey=xxxxxxx&Signature=xxxxxx&Query=test&ResponseType=XML
URL Parameters | Description |
---|---|
Version | The version of the API to call (0.1 ). |
Method | The method being called (SearchTitles ). |
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. |
Query | The search query. |
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 , name , created , modified , publish_date , status , Title.id , Title.title , Title.created , Title.modified , User.id , or User.username ). |
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>
<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>
<Title>
<id>12345</id>
<title>ACME Reporter</title>
<created>2009-08-24 18:49:18</created>
<modified>2010-12-19 18:51:52</modified>
</Title>
<User>
<id>1876</id>
<username>johndoe1</username>
</User>
</Issue>
<Issue>
...
</Issue>
</Response>