InboundWS Web Service

InboundWS

Click here for a complete list of operations.

GetInboundItemList

Retrieve list of Item IDs from the server based on the search criteria

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/GetInboundItemList"

<?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>
    <GetInboundItemList xmlns="https://iws.concordfax.com/InboundWS/">
      <authentication>
        <UserId>string</UserId>
        <Password>string</Password>
      </authentication>
      <request>
        <MaxItems>int</MaxItems>
        <Dnis>string</Dnis>
        <ArchivedItems>boolean</ArchivedItems>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
      </request>
    </GetInboundItemList>
  </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>
    <GetInboundItemListResponse xmlns="InboundWS">
      <GetInboundItemListResult>
        <InboundItemIDs xmlns="https://iws.concordfax.com/InboundWS/">
          <string>string</string>
          <string>string</string>
        </InboundItemIDs>
        <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>
      </GetInboundItemListResult>
    </GetInboundItemListResponse>
  </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>
    <GetInboundItemList xmlns="https://iws.concordfax.com/InboundWS/">
      <authentication>
        <UserId>string</UserId>
        <Password>string</Password>
      </authentication>
      <request>
        <MaxItems>int</MaxItems>
        <Dnis>string</Dnis>
        <ArchivedItems>boolean</ArchivedItems>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
      </request>
    </GetInboundItemList>
  </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>
    <GetInboundItemListResponse xmlns="InboundWS">
      <GetInboundItemListResult>
        <InboundItemIDs xmlns="https://iws.concordfax.com/InboundWS/">
          <string>string</string>
          <string>string</string>
        </InboundItemIDs>
        <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>
      </GetInboundItemListResult>
    </GetInboundItemListResponse>
  </soap12:Body>
</soap12:Envelope>