API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.updateExternalSourceLooop

Creates a new looop from an external source.
Category: looop functions
Subcategory: looop creation & deletion
Description: Creates a new looop from an external source.

Note: If you call this function as an anonymous user, the parameters name and descriptiveName are ignored and set to null.

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 to be marked as external-source. Uses an existing looop or a looop created in a setup-looop-context
extUpdateNow boolean required Start update immediatly in the background
extStatus string -
extAttributes string required List Attributes for external source. The format in the array is: attribute-name, attribute-value, attribute-name, attribute-value, ...

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
permalink string HTTP permalink of the looop
source string looop external source typ
status string looop external source status
createdTimestamp string looop external source created timestamp
updatedTimestamp string looop external source updated timestamp
scheduledUpdateTimestamp string looop external source scheduled next update timestmp

Errors / Exceptions

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

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.updateExternalSourceLooop
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &looopID=uuiduuid-uuid-uuid-uuid-uuiduuiduuid (optional)
    &extUpdateNow=
    &extStatus=string-value (optional)
    &extAttributes=string-value
    &extAttributes=string-value (multiple possible)



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="permalink">
      <value>string-value</value>
   </response>
   <response name="source">
      <value>string-value</value>
   </response>
   <response name="status">
      <value>string-value</value>
   </response>
   <response name="createdTimestamp">
      <value>string-value</value>
   </response>
   <response name="updatedTimestamp">
      <value>string-value</value>
   </response>
   <response name="scheduledUpdateTimestamp">
      <value>string-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.