DocumentServiceDelivery Web Service

DocumentServiceDelivery

Click here for a complete list of operations.

RetrieveDocumentPointers

RetrieveDocumentPointers will return an array of all documents attached to an item with a matching barcode value. Each pointer includes information necessary to return a document

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /DocumentServiceDelivery.asmx HTTP/1.1
Host: itxuaexternalservices.interplx.dev
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://externalservices.interplx.com/InterplXServiceRouter/DocumentServiceDelivery/RetrieveDocumentPointers"

<?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>
    <RetrieveDocumentPointers xmlns="https://externalservices.interplx.com/InterplXServiceRouter/DocumentServiceDelivery">
      <pBarcodeValue>string</pBarcodeValue>
      <pIncludeThumbnails>boolean</pIncludeThumbnails>
      <AccessToken>base64Binary</AccessToken>
    </RetrieveDocumentPointers>
  </soap:Body>
</soap:Envelope>

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>
    <RetrieveDocumentPointersResponse xmlns="https://externalservices.interplx.com/InterplXServiceRouter/DocumentServiceDelivery">
      <RetrieveDocumentPointersResult>
        <DocumentPointer>
          <DocumentClaimCheck xmlns="http://localhost/ITXImageService/Service">string</DocumentClaimCheck>
          <AttachmentDateTime xmlns="http://localhost/ITXImageService/Service">dateTime</AttachmentDateTime>
          <KilobyteSize xmlns="http://localhost/ITXImageService/Service">int</KilobyteSize>
          <PageCount xmlns="http://localhost/ITXImageService/Service">int</PageCount>
          <ArchiveMimeType xmlns="http://localhost/ITXImageService/Service">string</ArchiveMimeType>
          <TransferMimeType xmlns="http://localhost/ITXImageService/Service">string</TransferMimeType>
          <ThumbNailImage xmlns="http://localhost/ITXImageService/Service">base64Binary</ThumbNailImage>
        </DocumentPointer>
        <DocumentPointer>
          <DocumentClaimCheck xmlns="http://localhost/ITXImageService/Service">string</DocumentClaimCheck>
          <AttachmentDateTime xmlns="http://localhost/ITXImageService/Service">dateTime</AttachmentDateTime>
          <KilobyteSize xmlns="http://localhost/ITXImageService/Service">int</KilobyteSize>
          <PageCount xmlns="http://localhost/ITXImageService/Service">int</PageCount>
          <ArchiveMimeType xmlns="http://localhost/ITXImageService/Service">string</ArchiveMimeType>
          <TransferMimeType xmlns="http://localhost/ITXImageService/Service">string</TransferMimeType>
          <ThumbNailImage xmlns="http://localhost/ITXImageService/Service">base64Binary</ThumbNailImage>
        </DocumentPointer>
      </RetrieveDocumentPointersResult>
    </RetrieveDocumentPointersResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /DocumentServiceDelivery.asmx HTTP/1.1
Host: itxuaexternalservices.interplx.dev
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveDocumentPointers xmlns="https://externalservices.interplx.com/InterplXServiceRouter/DocumentServiceDelivery">
      <pBarcodeValue>string</pBarcodeValue>
      <pIncludeThumbnails>boolean</pIncludeThumbnails>
      <AccessToken>base64Binary</AccessToken>
    </RetrieveDocumentPointers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveDocumentPointersResponse xmlns="https://externalservices.interplx.com/InterplXServiceRouter/DocumentServiceDelivery">
      <RetrieveDocumentPointersResult>
        <DocumentPointer>
          <DocumentClaimCheck xmlns="http://localhost/ITXImageService/Service">string</DocumentClaimCheck>
          <AttachmentDateTime xmlns="http://localhost/ITXImageService/Service">dateTime</AttachmentDateTime>
          <KilobyteSize xmlns="http://localhost/ITXImageService/Service">int</KilobyteSize>
          <PageCount xmlns="http://localhost/ITXImageService/Service">int</PageCount>
          <ArchiveMimeType xmlns="http://localhost/ITXImageService/Service">string</ArchiveMimeType>
          <TransferMimeType xmlns="http://localhost/ITXImageService/Service">string</TransferMimeType>
          <ThumbNailImage xmlns="http://localhost/ITXImageService/Service">base64Binary</ThumbNailImage>
        </DocumentPointer>
        <DocumentPointer>
          <DocumentClaimCheck xmlns="http://localhost/ITXImageService/Service">string</DocumentClaimCheck>
          <AttachmentDateTime xmlns="http://localhost/ITXImageService/Service">dateTime</AttachmentDateTime>
          <KilobyteSize xmlns="http://localhost/ITXImageService/Service">int</KilobyteSize>
          <PageCount xmlns="http://localhost/ITXImageService/Service">int</PageCount>
          <ArchiveMimeType xmlns="http://localhost/ITXImageService/Service">string</ArchiveMimeType>
          <TransferMimeType xmlns="http://localhost/ITXImageService/Service">string</TransferMimeType>
          <ThumbNailImage xmlns="http://localhost/ITXImageService/Service">base64Binary</ThumbNailImage>
        </DocumentPointer>
      </RetrieveDocumentPointersResult>
    </RetrieveDocumentPointersResponse>
  </soap12:Body>
</soap12:Envelope>