InboundWS Web Service

InboundWS

Click here for a complete list of operations.

GetInboundItemsByIDEx

Retrieve Items from the server based on supplied MessageIDs

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 /inboundws/v1/inboundws.asmx HTTP/1.1
Host: iws.concordfax.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://iws.concordfax.com/InboundWS/GetInboundItemsByIDEx"

<?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>
    <GetInboundItemsByIDEx xmlns="https://iws.concordfax.com/InboundWS/">
      <authentication>
        <UserId>string</UserId>
        <Password>string</Password>
      </authentication>
      <request>
        <InboundItemIDs>
          <string>string</string>
          <string>string</string>
        </InboundItemIDs>
        <ReqSettings>
          <DimeSettings>
            <EncryptedItem>boolean</EncryptedItem>
            <ItemSecretKeys xsi:nil="true" />
          </DimeSettings>
          <ItemSecurityMode>
            <Chunked>boolean</Chunked>
            <DigitallySigned>boolean</DigitallySigned>
            <Ecrypted>boolean</Ecrypted>
            <EncryptionType>string</EncryptionType>
            <UseDIME>boolean</UseDIME>
          </ItemSecurityMode>
        </ReqSettings>
      </request>
    </GetInboundItemsByIDEx>
  </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>
    <GetInboundItemsByIDExResponse xmlns="InboundWS">
      <GetInboundItemsByIDExResult>
        <InboundItems xmlns="https://iws.concordfax.com/InboundWS/">
          <InboundItemEx>
            <UserID>string</UserID>
            <Document xsi:nil="true" />
            <DimeSettings xsi:nil="true" />
          </InboundItemEx>
          <InboundItemEx>
            <UserID>string</UserID>
            <Document xsi:nil="true" />
            <DimeSettings xsi:nil="true" />
          </InboundItemEx>
        </InboundItems>
        <InboundItemCount xmlns="https://iws.concordfax.com/InboundWS/">int</InboundItemCount>
        <Success xmlns="https://iws.concordfax.com/InboundWS/">boolean</Success>
        <Messages xmlns="https://iws.concordfax.com/InboundWS/">
          <WSError>
            <ErrorCode>int</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
          </WSError>
          <WSError>
            <ErrorCode>int</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
          </WSError>
        </Messages>
        <FailureCount xmlns="https://iws.concordfax.com/InboundWS/">int</FailureCount>
        <FailedItemIDs xmlns="https://iws.concordfax.com/InboundWS/">
          <string>string</string>
          <string>string</string>
        </FailedItemIDs>
      </GetInboundItemsByIDExResult>
    </GetInboundItemsByIDExResponse>
  </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 /inboundws/v1/inboundws.asmx HTTP/1.1
Host: iws.concordfax.com
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>
    <GetInboundItemsByIDEx xmlns="https://iws.concordfax.com/InboundWS/">
      <authentication>
        <UserId>string</UserId>
        <Password>string</Password>
      </authentication>
      <request>
        <InboundItemIDs>
          <string>string</string>
          <string>string</string>
        </InboundItemIDs>
        <ReqSettings>
          <DimeSettings>
            <EncryptedItem>boolean</EncryptedItem>
            <ItemSecretKeys xsi:nil="true" />
          </DimeSettings>
          <ItemSecurityMode>
            <Chunked>boolean</Chunked>
            <DigitallySigned>boolean</DigitallySigned>
            <Ecrypted>boolean</Ecrypted>
            <EncryptionType>string</EncryptionType>
            <UseDIME>boolean</UseDIME>
          </ItemSecurityMode>
        </ReqSettings>
      </request>
    </GetInboundItemsByIDEx>
  </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>
    <GetInboundItemsByIDExResponse xmlns="InboundWS">
      <GetInboundItemsByIDExResult>
        <InboundItems xmlns="https://iws.concordfax.com/InboundWS/">
          <InboundItemEx>
            <UserID>string</UserID>
            <Document xsi:nil="true" />
            <DimeSettings xsi:nil="true" />
          </InboundItemEx>
          <InboundItemEx>
            <UserID>string</UserID>
            <Document xsi:nil="true" />
            <DimeSettings xsi:nil="true" />
          </InboundItemEx>
        </InboundItems>
        <InboundItemCount xmlns="https://iws.concordfax.com/InboundWS/">int</InboundItemCount>
        <Success xmlns="https://iws.concordfax.com/InboundWS/">boolean</Success>
        <Messages xmlns="https://iws.concordfax.com/InboundWS/">
          <WSError>
            <ErrorCode>int</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
          </WSError>
          <WSError>
            <ErrorCode>int</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
          </WSError>
        </Messages>
        <FailureCount xmlns="https://iws.concordfax.com/InboundWS/">int</FailureCount>
        <FailedItemIDs xmlns="https://iws.concordfax.com/InboundWS/">
          <string>string</string>
          <string>string</string>
        </FailedItemIDs>
      </GetInboundItemsByIDExResult>
    </GetInboundItemsByIDExResponse>
  </soap12:Body>
</soap12:Envelope>