SOAP services

This document describes how SOAP services are working. The calls examples are given using the curl command line tool (that can easily be transposed to any HTTP client tool or API).

Note: the -b cookies.txt -c cookies.txt parameters of the curl calls bellow are required as they allow to use the same server session (identified by the JSESSIONID cookie).

For an application named myapp, the base URL of the SOAP services is:

http[s]://<host[:<port>]>/myappws/soap

As of version 3.0 MAINTENANCE 20, the API endpoint is also available in the main webapp /myapp (this allows to avoid deploying the webservice gateway webapp /myappws):_

http[s]://<host[:<port>]>/myapp/api/soap

if you are using this API endpoint please refer to this document for details on the authentication mechanisms.

It will be noted <base URL> in the rest of the document.

Warning: In production the services endpoint's URL should be restricted only to allowed origins e.g. using URL filtering based on request's origin IP address or similar approaches.

Business object services

The URL of the SOAP services endpoint for the SystemParam business object is:

<base URL>?object=SystemParam

It will be noted <object endpoint URL> in the rest of this section.

WSDL contract

The WSDL for the SystemParamobject can be displayed using the wsdlparameter to the object base URL:

curl -b cookies.txt -c cookies.txt -u <login>[:<password>] "<object endpoint URL>&wsdl=true"

Example service call

For instance to do a simple search on the SystemParam business object, you can call:

curl -b cookies.txt -c cookies.txt -u <login>[:<password>] -X POST -H "Content-Type: text/xml" [-H "SOAPAction: search"] -d @request.xml "<object endpoint URL>"

Note: the SOAPAction header is not mandatory (but this is part of the SOAP protocol, no harm adding it).

Where request.xml has the following content:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://myapp/SystemParam">
    <soap:Body>
        <ns1:search/>
    </soap:Body>
</soap:Envelope>

Please check the WSDL for details on all other business object's services.