API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.sendImage

Sends an invitation for an image to one or more e-mail addresses.
Category: Invitations
Subcategory:
Description: Sends an invitation for an image to one or more e-mail addresses.

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
imageID uuid required ID of the image to send an invitation e-mail for.
senderName string Sender name used for the mail unless user is logged in. Mandatory for anonymous requests.
senderMail string Sender e-mail address used for the mail unless user is logged in. Mandatory for anonymous requests.
recipients string required Comma separated list of e-mail addresses to send the invitation to.
message string required Additional comment to put in the e-mail message.
looopID uuid unused
includeAllFriends boolean unused

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
2006 imagelooop.InvalidParameterValueException
2005 imagelooop.InternalErrorException
2003 imagelooop.MissingMandatoryParameterNameException
3000 imagelooop.PrimaryObjectNotFoundException

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.sendImage
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &imageID=uuiduuid-uuid-uuid-uuid-uuiduuiduuid
    &senderName=string-value (optional)
    &senderMail=string-value (optional)
    &recipients=string-value
    &message=string-value
    &looopID=uuiduuid-uuid-uuid-uuid-uuiduuiduuid (optional)
    &includeAllFriends= (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/">
</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.