API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.setLooopMetaData

Change looop meta information.
Category: looop functions
Subcategory: looop meta data
Description: Change looop 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 required ID of the looop to load meta data for
descriptiveName string looop visible name
description string looop description
looopExternalLink string external link
tags string image tags
teaserContentId uuid ID of the looop's title image
randomPlayOrder boolean webplayer random image order
language string looop language
accessType string looop access type
publishLooop boolean publish looop flag
webPlayerType string internal looop player name
playerConfig map looop player configuration. For possible values, take a look at the available playerConfig Parameters

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
3004 imagelooop.PermissionDeniedException
3000 imagelooop.PrimaryObjectNotFoundException
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.setLooopMetaData
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &looopID=uuiduuid-uuid-uuid-uuid-uuiduuiduuid
    &descriptiveName=string-value (optional)
    &description=string-value (optional)
    &looopExternalLink=string-value (optional)
    &tags=string-value (optional)
    &teaserContentId=uuiduuid-uuid-uuid-uuid-uuiduuiduuid (optional)
    &randomPlayOrder= (optional)
    &language=string-value (optional)
    &accessType=string-value (optional)
    &publishLooop= (optional)
    &webPlayerType=string-value (optional)
    &playerConfig= (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.