API Home       Error Codes       Your API Keys

imageloop API - SOAP transport



The WSDL source can be taken from www.imageloop.com/soap/api/api.wsdl, which referes to the XSD file www.imageloop.com/soap/api/api.xsd.

Please note, that WSDL unions are not used in the WSDL, because they are not mapped correctly in some development environments. Instead we use constructs like minOccurs="0" with maxOccurs="1".

All functions, that upload content to imageloop are not available via SOAP transport.



WSDL hierarchy and types





The three operations Invocation, InvocationHandled and InvocationBatchHandled can all perform the same operations.

  • Invocation calls a single imageloop API function and throws exceptions using SOAP functionality.
  • InvocationHandled calls a single imageloop API function but returns either a InvocationResponseType object or a InvocationFaultType object in ResultType.
  • InvocationBatchHandled performs multiple (one or more) imageloop API functions in a single SOAP request. Requests are passed in InvocationBatchRequestType, which contains the distinct InvocationRequestType objects. Each encapsulated request in InvocationBatchRequestType has a corresponding result item in InvocationBatchResponseType that contains either a InvocationResponseType object or a InvocationFaultType object.



InvocationRequestType


Request object for SOAP operations Invocation and InvocationHandled.

An InvocationRequestType contains the name of the imageloop API function to call and the parameters. A parameter can be either a single string value in ParameterType.value, a list of values (or maps) in ParameterType.list or a map in ParameterType.map. A list of all imageloop API functions is available here.



InvocationResponseType


Successful API call responses are returned in InvocationResponseType. It contains zero or more return parameters. A parameter can be either a single string value in ParameterType.value, a list of string values in ParameterType.list or a map in ParameterType.map.



InvocationFaultType


Fault object for SOAP operations InvocationFaultType.

Failed imageloop API calls are indicated by a InvocationFaultType object. It contains an error code plus the error type and an optional error message (always english at the moment). Please see this page for a list of all error codes or the error codes shown for each imageloop API function.



InvocationBatchRequestType


Request object for SOAP operation InvocationBatchHandled.

Batch requests consists of one or more InvocationResponseTypes encapsulated in a single InvocationBatchRequestType object.



InvocationBatchResponseType


Result object for SOAP operation InvocationBatchHandled.

Responses for batch requests are encapsulated in a InvocationBatchResponseType object. The response for the first request in InvocationBatchRequestType is located in the first InvocationBatchResponseItemType object in InvocationBatchResponseType. The response for the second request in the second and so on.



InvocationBatchResponseItemType


Single responses for all InvocationResponseType objects in a InvocationBatchRequestType object are encapsulated in InvocationBatchResponseItemType objects. It contains either a InvocationResponseType or a InvocationFaultType object.



ResponseType


Results for SOAP operations to InvocationHandled
Contains either a InvocationResponseType object or a InvocationFaultType object.



ParameterType


The ParameterType object contains either a single string value in value, a list of values (or maps) in list or a map in map. Only one of these fields must contain a value.



ValueListType


A ValueListType object contains either a list of strings in value or a list of maps in map.



ValueMapType


Maps are represented by ValueMapType objects. They contain a list of NamedValueType objects, which are just simple name=value representations.



NamedValueType


Each NamedValueType object contains a single name=value representation.