ConnectivityPlatform Web Service

ConnectivityPlatform

Click here for a complete list of operations.

ImportForBook

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

<?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>
    <ImportForBook xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <PickupDateTime>dateTime</PickupDateTime>
        <BOLNumber>string</BOLNumber>
        <DispatchLoad>boolean</DispatchLoad>
        <DispatchOverride>boolean</DispatchOverride>
        <SubmitPickup>boolean</SubmitPickup>
        <ProNumber>string</ProNumber>
        <ActualCarrierName>string</ActualCarrierName>
        <QuoteInformation>
          <QuoteID>int</QuoteID>
          <SCAC>string</SCAC>
          <TransitTime>int</TransitTime>
          <TotalCharge>decimal</TotalCharge>
          <FreightCharge>decimal</FreightCharge>
          <FuelSurcharge>decimal</FuelSurcharge>
          <DiscountPercentage>decimal</DiscountPercentage>
          <DiscountAmount>decimal</DiscountAmount>
          <AccessorialFees>decimal</AccessorialFees>
          <Minumum>decimal</Minumum>
          <GrossCharge>decimal</GrossCharge>
          <OtherCharges>decimal</OtherCharges>
          <Tariff>string</Tariff>
          <Interline>boolean</Interline>
          <Miles>int</Miles>
          <QuoteNumber>string</QuoteNumber>
          <AccountNumber>string</AccountNumber>
          <CarrierPrice>decimal</CarrierPrice>
          <CustomerPrice>decimal</CustomerPrice>
          <Note>string</Note>
          <CurrencyID>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyID>
          <ThirdPartySCAC>string</ThirdPartySCAC>
          <CarrierName>string</CarrierName>
          <ServiceLevel>string</ServiceLevel>
        </QuoteInformation>
      </request>
    </ImportForBook>
  </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>
    <ImportForBookResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <ImportForBookResult>
        <LoadID>int</LoadID>
        <QuoteInformation>
          <QuoteID>int</QuoteID>
          <SCAC>string</SCAC>
          <TransitTime>int</TransitTime>
          <TotalCharge>decimal</TotalCharge>
          <FreightCharge>decimal</FreightCharge>
          <FuelSurcharge>decimal</FuelSurcharge>
          <DiscountPercentage>decimal</DiscountPercentage>
          <DiscountAmount>decimal</DiscountAmount>
          <AccessorialFees>decimal</AccessorialFees>
          <Minumum>decimal</Minumum>
          <GrossCharge>decimal</GrossCharge>
          <OtherCharges>decimal</OtherCharges>
          <Tariff>string</Tariff>
          <Interline>boolean</Interline>
          <Miles>int</Miles>
          <QuoteNumber>string</QuoteNumber>
          <AccountNumber>string</AccountNumber>
          <CarrierPrice>decimal</CarrierPrice>
          <CustomerPrice>decimal</CustomerPrice>
          <Note>string</Note>
          <CurrencyID>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyID>
          <ThirdPartySCAC>string</ThirdPartySCAC>
          <CarrierName>string</CarrierName>
          <ServiceLevel>string</ServiceLevel>
        </QuoteInformation>
        <BookResponse>
          <Success>boolean</Success>
          <Error>
            <Message>string</Message>
          </Error>
          <request>
            <AuthenticationData xsi:nil="true" />
            <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 xsi:nil="true" />
            <Warnings xsi:nil="true" />
          </DispatchResponse>
          <ProNumber>string</ProNumber>
        </BookResponse>
      </ImportForBookResult>
    </ImportForBookResponse>
  </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>
    <ImportForBook xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <PickupDateTime>dateTime</PickupDateTime>
        <BOLNumber>string</BOLNumber>
        <DispatchLoad>boolean</DispatchLoad>
        <DispatchOverride>boolean</DispatchOverride>
        <SubmitPickup>boolean</SubmitPickup>
        <ProNumber>string</ProNumber>
        <ActualCarrierName>string</ActualCarrierName>
        <QuoteInformation>
          <QuoteID>int</QuoteID>
          <SCAC>string</SCAC>
          <TransitTime>int</TransitTime>
          <TotalCharge>decimal</TotalCharge>
          <FreightCharge>decimal</FreightCharge>
          <FuelSurcharge>decimal</FuelSurcharge>
          <DiscountPercentage>decimal</DiscountPercentage>
          <DiscountAmount>decimal</DiscountAmount>
          <AccessorialFees>decimal</AccessorialFees>
          <Minumum>decimal</Minumum>
          <GrossCharge>decimal</GrossCharge>
          <OtherCharges>decimal</OtherCharges>
          <Tariff>string</Tariff>
          <Interline>boolean</Interline>
          <Miles>int</Miles>
          <QuoteNumber>string</QuoteNumber>
          <AccountNumber>string</AccountNumber>
          <CarrierPrice>decimal</CarrierPrice>
          <CustomerPrice>decimal</CustomerPrice>
          <Note>string</Note>
          <CurrencyID>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyID>
          <ThirdPartySCAC>string</ThirdPartySCAC>
          <CarrierName>string</CarrierName>
          <ServiceLevel>string</ServiceLevel>
        </QuoteInformation>
      </request>
    </ImportForBook>
  </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>
    <ImportForBookResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <ImportForBookResult>
        <LoadID>int</LoadID>
        <QuoteInformation>
          <QuoteID>int</QuoteID>
          <SCAC>string</SCAC>
          <TransitTime>int</TransitTime>
          <TotalCharge>decimal</TotalCharge>
          <FreightCharge>decimal</FreightCharge>
          <FuelSurcharge>decimal</FuelSurcharge>
          <DiscountPercentage>decimal</DiscountPercentage>
          <DiscountAmount>decimal</DiscountAmount>
          <AccessorialFees>decimal</AccessorialFees>
          <Minumum>decimal</Minumum>
          <GrossCharge>decimal</GrossCharge>
          <OtherCharges>decimal</OtherCharges>
          <Tariff>string</Tariff>
          <Interline>boolean</Interline>
          <Miles>int</Miles>
          <QuoteNumber>string</QuoteNumber>
          <AccountNumber>string</AccountNumber>
          <CarrierPrice>decimal</CarrierPrice>
          <CustomerPrice>decimal</CustomerPrice>
          <Note>string</Note>
          <CurrencyID>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyID>
          <ThirdPartySCAC>string</ThirdPartySCAC>
          <CarrierName>string</CarrierName>
          <ServiceLevel>string</ServiceLevel>
        </QuoteInformation>
        <BookResponse>
          <Success>boolean</Success>
          <Error>
            <Message>string</Message>
          </Error>
          <request>
            <AuthenticationData xsi:nil="true" />
            <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 xsi:nil="true" />
            <Warnings xsi:nil="true" />
          </DispatchResponse>
          <ProNumber>string</ProNumber>
        </BookResponse>
      </ImportForBookResult>
    </ImportForBookResponse>
  </soap12:Body>
</soap12:Envelope>