API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.queryImages

Find images by query string
Category: Query functions
Subcategory:
Description: Searches for images matching the given query string and returns a list of looop+image IDs. Each element in the returned list is a string containing the looop and image ID seperated by a comma ',' .

Parameters

Only mandatory parameters must be present for an API call on this function. Parameters marked as a list can occur multiple times in both SOAP and HTTP-RPC style requests.
Name Type Mandatory is List Description
query string required The query string.
offset int Offset of the returned list within the whole query result set.
max int Maximum size of the returned list.

Return Values

The presence of return values depend on the meaning of the API function and status of the requested object. For example, the description value of a looop will not be returned, if it has not been set.
Name Type is List Description
imageID string List looop and image IDs of the images matching the query string
hasMore boolean true, if more results are available

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
2006 imagelooop.InvalidParameterValueException

API Call examples

HTTP-RPC

Request:
The line breaks and white spaces are for better reading only. All request parameters can be passed in the HTTP POST request body instead of a HTTP GET parameter in a URL. Valid HTTP POST content types are multipart/form-data for file uploads and application/x-www-form-urlencoded for usual HTML forms.

http://www.imageloop.com/httprpc/?apiKey=YOUR-API-KEY
    &f=imagelooop.queryImages
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &query=string-value
    &offset= (optional)
    &max= (optional)



Sample response

Sample Response to illustrate what's returned (XML schema) :
The line breaks and white spaces are for better reading only.

<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <response name="imageID">
      <list>
         <value>string-value</value>
         <value>string-value</value>
         ... (more or less value elements) ...
      </list>
   </response>
   <response name="hasMore">
      <value>boolean-value</value>
   </response>
</imag:Response>
If the function call resulted in an error, no response element but an error element is returned in the above XML. See list of possible errors/exception for the function described on this page.
<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <error>
      <errorCode>error-code</errorCode>
      <errorType>error-name</errorType>
      <message>optional error message</message>
   </error>
</imag:Response>

SOAP

General overview including SOAP and XML schema types is available here. See http://www.imageloop.com/soap/api/api.wsdl for WSDL definition. http://www.imageloop.com/soap/api/api.xsd for XSD definition.