Receiving results of SubmitAsyncEx2

To receive the results, a web service must be implemented that implements the function ReplyAsyncEx2 if the request was sent using the 'bare' variant (itpserver.asmx) or the function ReplyAsyncEx2Wrapped if the request was sent using the 'wrapped' variant (itpserverwrapped.asmx). These functions receive as parameters:

jobResult
The result/error indication of running the job (in string format).

outKeyValues
An array of key/values sent by the ITP/Server service.

outDocuments
An array of files generated by the ITP/Server service.

progress
An array of progress messages sent by the ITP/Server service.

correlationId
The call identification that was specified when submitting the job.

The function ReplyAsyncEx2(Wrapped) should return a result/error string, which, except for optional logging, is discarded.

itpserverreply.dll

itpserverreply.dll provides a reference implementation that serves to specify the interface. First, you have to install the Web Services interface. For more information, refer to the ITP/Server Installation Guide chapter Installing the ASP.NET Web Services interface, or chapter Installing the J2EE Web Services interface. Then, browse to the following URLs for sample request and reply messages:

• http://..../itpserverreply.asmx?WSDL for the WSDL specification
• http://..../itpserverreply.asmx?op=ReplyAsync
• http://..../itpserverreply.asmx?op=ReplyAsyncWrapped

"<host:port>/<folder>" is the machine/folder in which the Web Services interface is installed, e.g., localhost:8080/itpserver.

The web service implemented by you must adhere to this interface specification.

Sample request (bare version)

POST /itpserver/itpserverreply.asmx HTTP/1.1

Host: localhost

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

Content-Length: length

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

<?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>
    <jobResult xmlns="http://www.aia-itp.com/itpserver/wsdl">string</jobResult>
    <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>
    <correlationId xmlns="http://www.aia-itp.com/itpserver/wsdl">string</correlationId>
  </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>
    <result xmlns="http://www.aia-itp.com/itpserver/wsdl">string</result>
  </soap:Body>
</soap:Envelope>

Sample request (wrapped version)

POST /itpserver/itpserverreply.asmx HTTP/1.1

Host: localhost

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

Content-Length: length

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

<?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>
    <ReplyAsyncEx2Wrapped xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <jobResult>string</jobResult>
      <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>
        <string>string</string>
        <string>string</string>
      </progress>
      <correlationId>string</correlationId>
    </ReplyAsyncEx2Wrapped>
  </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>
    <ReplyAsyncEx2WrappedResponse xmlns="http://www.aia-itp.com/itpserver/wsdl">
      <result>string</result>
    </ReplyAsyncEx2WrappedResponse>
  </soap:Body>
</soap:Envelope>