SearchIssuePages¶
All Issue’s pages’ text are searched with the specified query and a result set is returned.
Request¶
GET https://api.uberflip.com/?Version=0.1&Method=SearchIssuePages&APIKey=xxxxxxx&Signature=xxxxxx&IssueId=1234&Query=test&ResponseType=XML
URL Parameters | Description |
---|---|
Version | The version of the API to call (0.1 ). |
Method | The method being called (SearchIssuePages ). |
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. |
IssueId | The identifier of the Issue to search for pages in. |
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 . |
Examples¶
Sample response:
<Response>
<Page>
<page_fl>7</page_fl>
<text>
...lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua nulla pariatur.
Excepteur sint occaecat cup...
</text>
<Issue>
<id>3579</id>
<name>Quartery Report - Q1 2011</name>
</Issue>
</Page>
<Page>
<page_fl>58</page_fl>
<text>
...nulla pariatur.Excepteur sint occaecat cup consectetur a
dipisicing elit, sed ...
</text>
<Issue>
<id>3579</id>
<name>Quartery Report - Q1 2011</name>
</Issue>
</Page>
<Page>
...
</Page>
</Response>