ConnectivityPlatform

Click here for a complete list of operations.

GetDocuments

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

<?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>
    <GetDocuments xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <LoadID>int</LoadID>
        <Documents>
          <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
          <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
        </Documents>
        <LabelOptions>
          <Format>ZPL or EPL or PDF</Format>
          <HasDockTabs>boolean</HasDockTabs>
        </LabelOptions>
        <ConversionOptions>
          <ConvertPDFToImage>boolean</ConvertPDFToImage>
          <ImageFormat>PNG or JPG</ImageFormat>
        </ConversionOptions>
      </request>
    </GetDocuments>
  </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>
    <GetDocumentsResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <GetDocumentsResult>
        <LoadID>int</LoadID>
        <Documents>
          <Document>
            <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
            <Base64Documents xsi:nil="true" />
            <ZPLDocuments xsi:nil="true" />
            <Success>boolean</Success>
            <Error xsi:nil="true" />
          </Document>
          <Document>
            <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
            <Base64Documents xsi:nil="true" />
            <ZPLDocuments xsi:nil="true" />
            <Success>boolean</Success>
            <Error xsi:nil="true" />
          </Document>
        </Documents>
        <Success>boolean</Success>
        <Error>
          <Message>string</Message>
        </Error>
      </GetDocumentsResult>
    </GetDocumentsResponse>
  </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>
    <GetDocuments xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <LoadID>int</LoadID>
        <Documents>
          <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
          <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
        </Documents>
        <LabelOptions>
          <Format>ZPL or EPL or PDF</Format>
          <HasDockTabs>boolean</HasDockTabs>
        </LabelOptions>
        <ConversionOptions>
          <ConvertPDFToImage>boolean</ConvertPDFToImage>
          <ImageFormat>PNG or JPG</ImageFormat>
        </ConversionOptions>
      </request>
    </GetDocuments>
  </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>
    <GetDocumentsResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <GetDocumentsResult>
        <LoadID>int</LoadID>
        <Documents>
          <Document>
            <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
            <Base64Documents xsi:nil="true" />
            <ZPLDocuments xsi:nil="true" />
            <Success>boolean</Success>
            <Error xsi:nil="true" />
          </Document>
          <Document>
            <DocumentType>Banyan_BOL or Shipping_Label or Carrier_BOL or Carrier_POD or Carrier_Label or AP or AR or Carrier_Weight</DocumentType>
            <Base64Documents xsi:nil="true" />
            <ZPLDocuments xsi:nil="true" />
            <Success>boolean</Success>
            <Error xsi:nil="true" />
          </Document>
        </Documents>
        <Success>boolean</Success>
        <Error>
          <Message>string</Message>
        </Error>
      </GetDocumentsResult>
    </GetDocumentsResponse>
  </soap12:Body>
</soap12:Envelope>