ConnectivityPlatform

Click here for a complete list of operations.

BookLoad

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

<?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>
    <BookLoad xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <LoadID>int</LoadID>
        <QuoteID>int</QuoteID>
        <PickupDateTime>dateTime</PickupDateTime>
        <ManifestID>string</ManifestID>
        <BOLNumber>string</BOLNumber>
        <CustomerCharge>decimal</CustomerCharge>
        <ReturnLatestLoadData>boolean</ReturnLatestLoadData>
        <EmailBOL>boolean</EmailBOL>
        <EmailAddress>string</EmailAddress>
        <DispatchRequest>
          <DispatchLoad>boolean</DispatchLoad>
          <DispatchOverride>boolean</DispatchOverride>
          <SubmitPickup>boolean</SubmitPickup>
          <ProNumber>string</ProNumber>
          <ActualCarrierName>string</ActualCarrierName>
        </DispatchRequest>
      </request>
    </BookLoad>
  </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>
    <BookLoadResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <BookLoadResult>
        <Success>boolean</Success>
        <Error>
          <Message>string</Message>
        </Error>
        <request>
          <AuthenticationData>
            <Username>string</Username>
            <Password>string</Password>
            <ClientRefNum>string</ClientRefNum>
          </AuthenticationData>
          <DebugMode>boolean</DebugMode>
        </request>
        <DispatchResponse>
          <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 xsi:nil="true" />
            <ErrorMessage xsi:nil="true" />
          </Errors>
          <Warnings>
            <Message>string</Message>
            <Message>string</Message>
          </Warnings>
        </DispatchResponse>
        <ProNumber>string</ProNumber>
      </BookLoadResult>
    </BookLoadResponse>
  </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>
    <BookLoad xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <LoadID>int</LoadID>
        <QuoteID>int</QuoteID>
        <PickupDateTime>dateTime</PickupDateTime>
        <ManifestID>string</ManifestID>
        <BOLNumber>string</BOLNumber>
        <CustomerCharge>decimal</CustomerCharge>
        <ReturnLatestLoadData>boolean</ReturnLatestLoadData>
        <EmailBOL>boolean</EmailBOL>
        <EmailAddress>string</EmailAddress>
        <DispatchRequest>
          <DispatchLoad>boolean</DispatchLoad>
          <DispatchOverride>boolean</DispatchOverride>
          <SubmitPickup>boolean</SubmitPickup>
          <ProNumber>string</ProNumber>
          <ActualCarrierName>string</ActualCarrierName>
        </DispatchRequest>
      </request>
    </BookLoad>
  </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>
    <BookLoadResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <BookLoadResult>
        <Success>boolean</Success>
        <Error>
          <Message>string</Message>
        </Error>
        <request>
          <AuthenticationData>
            <Username>string</Username>
            <Password>string</Password>
            <ClientRefNum>string</ClientRefNum>
          </AuthenticationData>
          <DebugMode>boolean</DebugMode>
        </request>
        <DispatchResponse>
          <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 xsi:nil="true" />
            <ErrorMessage xsi:nil="true" />
          </Errors>
          <Warnings>
            <Message>string</Message>
            <Message>string</Message>
          </Warnings>
        </DispatchResponse>
        <ProNumber>string</ProNumber>
      </BookLoadResult>
    </BookLoadResponse>
  </soap12:Body>
</soap12:Envelope>