ConnectivityPlatform

Click here for a complete list of operations.

GetShipments

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 /services/ConnectivityPlatform.asmx HTTP/1.1
Host: ws.logistics.banyantechnology.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.banyantechnology.com/Services/ConnectivityPlatform/GetShipments"

<?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>
    <GetShipments xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <Format>string</Format>
        <Statuses>
          <string>string</string>
          <string>string</string>
        </Statuses>
        <Page>int</Page>
        <PageSize>int</PageSize>
        <InvoiceStatusFilter>Approved or Cancelled or Duplicated or Posted or Printed or PaymentSent or Published or Queued or Open or Partial or Disputed or Paid or Closed or WriteOff or Exported or ApprovedDisputed or OpenDisputed or ExportedDisputed or OpenRevEngDisputed or Review</InvoiceStatusFilter>
        <IncludeExported>boolean</IncludeExported>
      </request>
    </GetShipments>
  </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>
    <GetShipmentsResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <GetShipmentsResult>
        <Data />
        <Success>boolean</Success>
        <TotalCount>int</TotalCount>
        <Errors>
          <string>string</string>
          <string>string</string>
        </Errors>
      </GetShipmentsResult>
    </GetShipmentsResponse>
  </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 /services/ConnectivityPlatform.asmx HTTP/1.1
Host: ws.logistics.banyantechnology.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>
    <GetShipments xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <Format>string</Format>
        <Statuses>
          <string>string</string>
          <string>string</string>
        </Statuses>
        <Page>int</Page>
        <PageSize>int</PageSize>
        <InvoiceStatusFilter>Approved or Cancelled or Duplicated or Posted or Printed or PaymentSent or Published or Queued or Open or Partial or Disputed or Paid or Closed or WriteOff or Exported or ApprovedDisputed or OpenDisputed or ExportedDisputed or OpenRevEngDisputed or Review</InvoiceStatusFilter>
        <IncludeExported>boolean</IncludeExported>
      </request>
    </GetShipments>
  </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>
    <GetShipmentsResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <GetShipmentsResult>
        <Data />
        <Success>boolean</Success>
        <TotalCount>int</TotalCount>
        <Errors>
          <string>string</string>
          <string>string</string>
        </Errors>
      </GetShipmentsResult>
    </GetShipmentsResponse>
  </soap12:Body>
</soap12:Envelope>