SubmitEx

The job SubmitEx is an extension to the job Submit. It allows for communication between the caller and the ITP/Server script. It allows the script to use Progress() to log messages to the caller, and it allows exchange_data() calls to get and set key/value pairs from/to the client. The job SubmitEx takes the same parameters as the submit job plus an array with key/value pairs as an extra parameter.

The job SubmitEx 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 Web Services interface.

Key/value pairs
Array of key/value pairs, which are ussed 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.

SubmitExResult
This contains the answer of ITP/Server to the Web Service request. This parameter can contain the following objects:

• Output files; files sent by ITP/Server will be stored here.
• Key/value pairs; the array with the key/value pairs as set in the function call and changed with the function exchange_data.
• Progress messages; result of calls of Progress() by the ITP/Server script.
• A string returned by ITP/Server, e.g., for error messages.

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/SubmitEx"

<?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>
  </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>
    <outKeyValues xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <KeyValue>
        <key>string</key>
        <value>string</value>
      </KeyValue>
      <KeyValue>
        <key>string</key>
        <value>string</value>
      </KeyValue>
    </outKeyValues>
    <outDocuments xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <Doc>
        <id>string</id>
        <content>base64Binary</content>
      </Doc>
      <Doc>
        <id>string</id>
        <content>base64Binary</content>
      </Doc>
    </outDocuments>
    <progress xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <string>string</string>
      <string>string</string>
    </progress>
  </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/SubmitEx"

<?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>
    <SubmitEx 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>
    </SubmitEx>
  </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>
    <SubmitExResponse xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <error>string</error>
      <outKeyValues>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </outKeyValues>
      <outDocuments>
        <Doc>
          <id>string</id>
          <content>base64Binary</content>
        </Doc>
        <Doc>
          <id>string</id>
          <content>base64Binary</content>
        </Doc>
      </outDocuments>
      <progress>
        <parm>string</parm>
        <parm>string</parm>
      </progress>
    </SubmitExResponse>
  </soap:Body>
</soap:Envelope>