ConnectivityPlatform

Click here for a complete list of operations.

DispatchLoad

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

<?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>
    <DispatchLoad xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <LoadID>int</LoadID>
        <SubmitPickup>boolean</SubmitPickup>
        <DispatchOverride>boolean</DispatchOverride>
        <LoadData>
          <ProNumber>string</ProNumber>
          <BOLNumber>string</BOLNumber>
          <ActualCarrierName>string</ActualCarrierName>
          <QuoteID>int</QuoteID>
        </LoadData>
      </request>
    </DispatchLoad>
  </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>
    <DispatchLoadResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <DispatchLoadResult>
        <LoadID>int</LoadID>
        <Success>boolean</Success>
        <PickupNumber>string</PickupNumber>
        <CarrierName>string</CarrierName>
        <QuoteNumber>string</QuoteNumber>
        <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
        <ProNumber>string</ProNumber>
        <UserMessage>string</UserMessage>
        <BOLLink>string</BOLLink>
        <Errors>
          <ErrorMessage>
            <Message>string</Message>
          </ErrorMessage>
          <ErrorMessage>
            <Message>string</Message>
          </ErrorMessage>
        </Errors>
        <Warnings>
          <Message>string</Message>
          <Message>string</Message>
        </Warnings>
      </DispatchLoadResult>
    </DispatchLoadResponse>
  </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>
    <DispatchLoad xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <LoadID>int</LoadID>
        <SubmitPickup>boolean</SubmitPickup>
        <DispatchOverride>boolean</DispatchOverride>
        <LoadData>
          <ProNumber>string</ProNumber>
          <BOLNumber>string</BOLNumber>
          <ActualCarrierName>string</ActualCarrierName>
          <QuoteID>int</QuoteID>
        </LoadData>
      </request>
    </DispatchLoad>
  </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>
    <DispatchLoadResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <DispatchLoadResult>
        <LoadID>int</LoadID>
        <Success>boolean</Success>
        <PickupNumber>string</PickupNumber>
        <CarrierName>string</CarrierName>
        <QuoteNumber>string</QuoteNumber>
        <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
        <ProNumber>string</ProNumber>
        <UserMessage>string</UserMessage>
        <BOLLink>string</BOLLink>
        <Errors>
          <ErrorMessage>
            <Message>string</Message>
          </ErrorMessage>
          <ErrorMessage>
            <Message>string</Message>
          </ErrorMessage>
        </Errors>
        <Warnings>
          <Message>string</Message>
          <Message>string</Message>
        </Warnings>
      </DispatchLoadResult>
    </DispatchLoadResponse>
  </soap12:Body>
</soap12:Envelope>