SubmitAsyncEx2

The SubmitAsyncEx2 job takes the same parameters as the SubmitEx2 job except the job is submitted asynchronous. Because the job is submitted asynchronous the call also needs a CorrelationID and a ReturnPath.

The SubmitAsyncEx2 job takes the following parameters:

Service
This is the name of the service the job is submitted to, e.g., RunMdl.

Parameters
The parameters for the job. They are passed as a string to the Web Services interface.

Key/value pairs
Array of key/value pairs, which are used for the function exchange_data.

Input files
Used to send files to ITP/Server that can be collected with the function ReceiveFile. The content of the file as well as the ID are passed. ITP/Server can use this ID to collect the file.

Job ID
The job will run on ITP/Server with this ID. If no job ID is passed on, the Web Service API will use a unique ID, so you can track your job in the ITP/Server logs.

SessionID
The job will run on ITP/Server within the context of the ITP session indicated by the sessionID. If no valid sessionID is passed on, ITP/Server will execute the job.

CorrelationID
This unique identifier is returned by the Web Services API as part of the returned SOAP message when a job is finished, so the calling application knows which task has finished.

ReturnPath
The URL to which the SOAP message is sent after the Web Services API finishes its task.

Sample request (bare version)

POST /itpserver/itpserver.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.aia-itp.com/itpserver/wsdl/SubmitAsyncEx"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <service xmlns="http://www.aia-itp.com/itpserver/wsdl">string</service>
    <parms xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <string>string</string>
      <string>string</string>
    </parms>
    <inKeyValues xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <KeyValue>
        <key>string</key>
        <value>string</value>
      </KeyValue>
      <KeyValue>
        <key>string</key>
        <value>string</value>
      </KeyValue>
    </inKeyValues>
    <inDocuments xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <Doc>
        <id>string</id>
        <content>base64Binary</content>
      </Doc>
      <Doc>
        <id>string</id>
        <content>base64Binary</content>
      </Doc>
    </inDocuments>
    <sessionID xmlns="http://www.aia-itp.com/itpserver/wsdl">string</sessionID>
    <jobID xmlns="http://www.aia-itp.com/itpserver/wsdl">string</jobID>
    <correlationId xmlns="http://www.aia-itp.com/itpserver/wsdl">string</correlationId>
    <returnPath xmlns="http://www.aia-itp.com/itpserver/wsdl">string</returnPath>
  </soap:Body>
</soap:Envelope>

Sample reply (bare version)

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <error xmlns="http://www.aia-itp.com/itpserver/wsdl">string</error>
  </soap:Body>
</soap:Envelope>

Sample request (wrapped version)

POST /itpserver/itpserverwrapped.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.aia-itp.com/itpserver/wsdl/SubmitAsyncEx2"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SubmitAsyncEx2 xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <service>string</service>
      <parms>
        <parm>string</parm>
        <parm>string</parm>
      </parms>
      <inKeyValues>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </inKeyValues>
      <inDocuments>
        <Doc>
          <id>string</id>
          <content>base64Binary</content>
        </Doc>
        <Doc>
          <id>string</id>
          <content>base64Binary</content>
        </Doc>
      </inDocuments>
      <sessionID>string</sessionID>
      <jobID>string</jobID>
      <correlationId>string</correlationId>
      <returnPath>string</returnPath>
    </SubmitAsyncEx2>
  </soap:Body>
</soap:Envelope>

Sample reply (wrapped version)

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SubmitAsyncEx2Response xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <error>string</error>
    </SubmitAsyncEx2Response>
  </soap:Body>
</soap:Envelope>