SubmitEx2

The job SubmitEx2 is again an extension to the job SubmitEx. It supports Job IDs and Session IDs. Therefore, the job SubmitEx2 takes the same parameters as the SubmitEx job plus some extra 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 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.

Session ID
The Session ID can be used to run an ITP Job in the context of an existing ITP session. If you pass on an invalid Session ID ITP/Server will execute the job, but not in the context of an ITP session.

Job ID
The Job ID can be used to identify the job in the ITP log files. If you pass on an empty value, the web service call will 'generate' a unique Job ID and use that when it submits the job.

SubmitEx2Result
This contains the answer of ITP/Server to the Web Service request. It 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/SubmitEx2"

<?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>
  </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/SubmitEx2"

<?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>
    <SubmitEx2 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>
    </SubmitEx2>
  </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>
    <SubmitEx2Response 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>
    </SubmitEx2Response>
  </soap:Body>
</soap:Envelope>