Image Retrieval Web Service

Estes provides a SOAP-based web service for retrieving scanned images.

WSDL

The WSDL for the web service can be accessed at the following URL:
http://www.estes-express.com/imageretrieval/services/ImageViewService?wsdl

SCHEMAS

The schemas used in the WSDL can be accessed at the links below:

http://www.estes-express.com/imageretrieval/services/ImageViewService?xsd=availableImagesRequest.xsd

http://www.estes-express.com/imageretrieval/services/ImageViewService?xsd=availableImagesResponse.xsd

http://www.estes-express.com/imageretrieval/services/ImageViewService?xsd=imagesRequest.xsd

http://www.estes-express.com/imageretrieval/services/ImageViewService?xsd=imagesResponse.xsd

http://www.estes-express.com/imageretrieval/services/ImageViewService?xsd=imageViewCommon.xsd

Retrieving the image is a two step process.

  1. imageCheck— Request the available images using the search criteria (PRO). The response gives the available image types - Bill of Lading (BOL) and/or Delivery Receipt (DR).
  2. imageView— Send a 2nd request with the search criteria and image type. The response contains the image file name and a base64-encoded string representation of the file contents.

*You need a My Estes account to  retrieve scanned images.

Return to API Overview Page


SAMPLE CODE

Echo Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tran="http://ws.estesexpress.com/transittime">
<soapenv:Header/>
<soapenv:Body>
<tran:echoRequest>20111220-1541</tran:echoRequest>
</soapenv:Body>
</soapenv:Envelope>

Echo Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<echoResponse xmlns="http://ws.estesexpress.com/transittime">20111220-1541</echoResponse>
</soapenv:Body>
</soapenv:Envelope>

Image View Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:imag="http://ws.estesexpress.com/imageview">
<soapenv:Header>
<imag:auth>
<imag:user>username</imag:user>
<imag:password>password</imag:password>
</imag:auth>
</soapenv:Header>
<soapenv:Body>
<imag:imgRequest>
<imag:requestID>20111222002</imag:requestID>
<imag:search>
<imag:item1>061</imag:item1>
<imag:item2>0159757</imag:item2>
</imag:search>
<imag:document>DR</imag:document>
</imag:imgRequest>
</soapenv:Body>
</soapenv:Envelope>

Image View Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<imgResponse xmlns="http://ws.estesexpress.com/imageview">
<requestID>20111222002</requestID>
<images>
<image>
<fileName>i0610159757DR1.gif</fileName>
<source></source>
</image>
</images>
</imgResponse>
</soapenv:Body>
</soapenv:Envelope>

Image Check Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:imag="http://ws.estesexpress.com/imageview">
<soap:Header>
<imag:auth>
<imag:user>username</imag:user>
<imag:password>password</imag:password>
</imag:auth>
</soap:Header>
<soap:Body>
<imag:availRequest>
<imag:requestID>20111222001</imag:requestID>
<imag:search>
<imag:item1>061</imag:item1>
<imag:item2>0159757</imag:item2>
</imag:search>
</imag:availRequest>
</soap:Body>
</soap:Envelope>

Image Check Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<availResponse xmlns="http://ws.estesexpress.com/imageview">
<requestID>20111222001</requestID>
<success>
<search>
<item1>061</item1>
<item2>0159757</item2>
</search>
<documents>
<document>BOL</document>
<document>DR</document>
</documents>
</success>
</availResponse>
</soapenv:Body>
</soapenv:Envelope>