API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.ping

This is a no-operation call to test whether communication between your application and imagelooop's server works.
Category: Test functions
Subcategory:
Description: Used to test the communication between the your application and the server. The method does not take any arguments nor does it return any value.

Do not call this method regularly.

Errors / Exceptions

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

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.ping
    &h=yourwebsite.com  - or -  &accessToken=application-access-token



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/">
</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.