User Tools

Site Tools


Reference SOAP implementation of EASA's WSDL

Generated in SoapUI


check

Check status of the current EASAP.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:check/>
   </soapenv:Body>
</soapenv:Envelope>

downloadFile

Download a file with the given path set in arg0.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:downloadFile>
         <!--Optional:-->
         <arg0>?</arg0>
      </ws3:downloadFile>
   </soapenv:Body>
</soapenv:Envelope>

endSession

Conclude the HTTP session and decrement the 'current users' counter (eg. the license-limited number of simultaneous users).

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:endSession/>
   </soapenv:Body>
</soapenv:Envelope>

getErrors

Query for error messages from the EASAP.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:getErrors/>
   </soapenv:Body>
</soapenv:Envelope>

getListValue

Return the current value of object named in arg0 .

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:getListValue>
         <!--Optional:-->
         <arg0>?</arg0>
      </ws3:getListValue>
   </soapenv:Body>
</soapenv:Envelope>

getProperty

Return the value of an object's parameter (arg0 is the object name, arg1 is the parameter name).

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:getProperty>
         <!--Optional:-->
         <arg0>?</arg0>
         <!--Optional:-->
         <arg1>?</arg1>
      </ws3:getProperty>
   </soapenv:Body>
</soapenv:Envelope>

getPublishedAppId

Return the full path of an EASAP (eg. 'examples/mortgage_calc/published/V1.1'). Message should contain a relative path to an EASAP (set arg0 to 'examples/mortgage_calc').

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:getPublishedAppId>
         <!--Optional:-->
         <arg0>?</arg0>
      </ws3:getPublishedAppId>
   </soapenv:Body>
</soapenv:Envelope>

getRunStatus

Query the status of a submitted run and received a string response.('No Run','Adding to Queue','Run Completed')

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:getRunStatus/>
   </soapenv:Body>
</soapenv:Envelope>

getValue

Enter the name of a SCALAR in arg0 to return its current value.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:getValue>
         <!--Optional:-->
         <arg0>?</arg0>
      </ws3:getValue>
   </soapenv:Body>
</soapenv:Envelope>

runActions

Enter the name of an BUTTON in arg0 to initiate its associated ACTION('s).

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:runActions>
         <!--Optional:-->
         <arg0>?</arg0>
      </ws3:runActions>
   </soapenv:Body>
</soapenv:Envelope>

setAuthenticationMethod

Establish the authentication protocol.

Set arg0 to '1' for CREDENTIALS (default) or '2' for SESSION (requires a valid session id to be set via a setEasaSession call).

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:setAuthenticationMethod>
         <arg0>?</arg0>
      </ws3:setAuthenticationMethod>
   </soapenv:Body>
</soapenv:Envelope>

setEasaSession

Establish a User session on the EASA Server. Set arg0 to a valid session id.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:setEasaSession>
         <!--Optional:-->
         <arg0>?</arg0>
      </ws3:setEasaSession>
   </soapenv:Body>
</soapenv:Envelope>

setListValue

Set the value of the named LIST in arg0 to the value in arg1.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:setListValue>
         <!--Optional:-->
         <arg0>?</arg0>
         <!--Zero or more repetitions:-->
         <arg1>?</arg1>
      </ws3:setListValue>
   </soapenv:Body>
</soapenv:Envelope>

setValue

Set the named SCALAR in arg0 to the value arg1.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:setValue>
         <!--Optional:-->
         <arg0>?</arg0>
         <!--Optional:-->
         <arg1>?</arg1>
      </ws3:setValue>
   </soapenv:Body>
</soapenv:Envelope>

startSession

Start an HTTP session on an EASAP Server with arg0 set to a full EASAP path from a getPublishedAppId call.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:startSession>
         <!--Optional:-->
         <arg0>?</arg0>
      </ws3:startSession>
   </soapenv:Body>
</soapenv:Envelope>

submit

Submit an EASAP for a run.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:submit/>
   </soapenv:Body>
</soapenv:Envelope>

touch

Always returns true message. Will show if a web service is active and can be connected to.

 
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:touch/>
   </soapenv:Body>
</soapenv:Envelope>

uploadFile

Upload a file to the EASA Server. Set arg0 to a FILE CHOICE, set arg1 to the filename of the file to upload, and arg2 to the actual file contents.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ws3="http://ws3.client.easa/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws3:uploadFile>
         <!--Optional:-->
         <arg0>?</arg0>
         <!--Optional:-->
         <arg1>?</arg1>
         <!--Optional:-->
         <arg2>cid:1405829759671</arg2>
      </ws3:uploadFile>
   </soapenv:Body>
</soapenv:Envelope>