API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.getImageMetaData

Get image meta information.
Category: Image functions
Subcategory: Image meta data
Description: Get image meta information.

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
looopID uuid ID of the looop containing the image
imageID uuid required ID of the image to load the meta data for

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
looopId uuid ID of the looop
imageId uuid ID of the image
name string image name
title string image title
contentLink string external link
description string image description
tags string List image tags (please note, that tags are returned as a comma separated string in a namedvalue)
permalink string HTTP permalink of the image
imageLink string URL template for loading image renditions. Replace the (first) @ character with the name of the rendition.
playerImageUrl string Full URL to the image for the player (rendition rw506h380)
rating string rating of the image
contentDatetime string Timestamp when the image has been taken (from EXIF information) - in ms since Jan, 1st 1970 midnight GMT
createdTimestamp string Creation timestamp in milliseconds since Jan, 1st 1970 midnight GMT
modifiedTimestamp string Modification timestamp in milliseconds since Jan, 1st 1970 midnight GMT
coordinates string geo coordinates
coordinatesAddress string coordinates address
ownerId uuid ID of the user who owns this image
ownerUsername uuid username of the image owner - only present, if the owner of the image is not the owner of the slideshow
ownerFirstName uuid firstname of the image owner - only present, if the owner of the image is not the owner of the slideshow
ownerLastName uuid lastname of the image owner - only present, if the owner of the image is not the owner of the slideshow
ownerMobile uuid mobile phone number of the image owner - only present, if the owner of the image is not the owner of the slideshow

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
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.getImageMetaData
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &looopID=uuiduuid-uuid-uuid-uuid-uuiduuiduuid (optional)
    &imageID=uuiduuid-uuid-uuid-uuid-uuiduuiduuid



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="looopId">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="imageId">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="name">
      <value>string-value</value>
   </response>
   <response name="title">
      <value>string-value</value>
   </response>
   <response name="contentLink">
      <value>string-value</value>
   </response>
   <response name="description">
      <value>string-value</value>
   </response>
   <response name="tags">
      <list>
         <value>string-value</value>
         <value>string-value</value>
         ... (more or less value elements) ...
      </list>
   </response>
   <response name="permalink">
      <value>string-value</value>
   </response>
   <response name="imageLink">
      <value>string-value</value>
   </response>
   <response name="playerImageUrl">
      <value>string-value</value>
   </response>
   <response name="rating">
      <value>string-value</value>
   </response>
   <response name="contentDatetime">
      <value>string-value</value>
   </response>
   <response name="createdTimestamp">
      <value>string-value</value>
   </response>
   <response name="modifiedTimestamp">
      <value>string-value</value>
   </response>
   <response name="coordinates">
      <value>string-value</value>
   </response>
   <response name="coordinatesAddress">
      <value>string-value</value>
   </response>
   <response name="ownerId">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="ownerUsername">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="ownerFirstName">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="ownerLastName">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="ownerMobile">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</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.