API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.getLooopByPermalinkEx

Return the metadata of the looop using this permalink.
Category: looop functions
Subcategory: looop queries
Description: Return the metadata of the looop using this permalink.

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
permalink string required permalink of the looop to get the ID 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
name string looop DNS name
name string looop DNS name
descriptiveName string looop visible name
description string looop description
looopExternalLink string external link
tags string List image tags
permalink string HTTP permalink of the looop
ownerId uuid ID of the user who owns this looop
teaserContentId uuid ID of the looop's title image
accessType string one of PRIVATE, SHARED or PUBLIC
rating string rating of the looop
contentCount int number of images of in the looop
randomPlayOrder boolean use web player random image ordering
language string looop language
createdTimestamp long Creation timestamp in milliseconds since Jan, 1st 1970 midnight GMT
modifiedTimestamp long Modification timestamp in milliseconds since Jan, 1st 1970 midnight GMT

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
2006 imagelooop.InvalidParameterValueException
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.getLooopByPermalinkEx
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &permalink=string-value



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="name">
      <value>string-value</value>
   </response>
   <response name="name">
      <value>string-value</value>
   </response>
   <response name="descriptiveName">
      <value>string-value</value>
   </response>
   <response name="description">
      <value>string-value</value>
   </response>
   <response name="looopExternalLink">
      <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="ownerId">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="teaserContentId">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="accessType">
      <value>string-value</value>
   </response>
   <response name="rating">
      <value>string-value</value>
   </response>
   <response name="contentCount">
      <value></value>
   </response>
   <response name="randomPlayOrder">
      <value>boolean-value</value>
   </response>
   <response name="language">
      <value>string-value</value>
   </response>
   <response name="createdTimestamp">
      <value>integer-value</value>
   </response>
   <response name="modifiedTimestamp">
      <value>integer-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.