ConnectivityPlatform Web Service

ConnectivityPlatform

Click here for a complete list of operations.

UpdateLoad

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

<?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>
    <UpdateLoad xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <AdditionalCustomerMarkup>decimal</AdditionalCustomerMarkup>
        <CustomerCharge>decimal</CustomerCharge>
      </request>
    </UpdateLoad>
  </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>
    <UpdateLoadResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <UpdateLoadResult>
        <Success>boolean</Success>
        <NeedsReRated>boolean</NeedsReRated>
        <ReRateReason>string</ReRateReason>
        <RatingComplete>boolean</RatingComplete>
        <Load>
          <AuthenticationData>
            <Username>string</Username>
            <Password>string</Password>
            <ClientRefNum>string</ClientRefNum>
          </AuthenticationData>
          <DebugMode>boolean</DebugMode>
        </Load>
        <Quotes>
          <Quote>
            <LoadID>int</LoadID>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <ThirdPartyName>string</ThirdPartyName>
            <ThirdPartySCAC>string</ThirdPartySCAC>
            <ServiceID>string</ServiceID>
            <RawPrice xsi:nil="true" />
            <CarrierPrice xsi:nil="true" />
            <CustomerPrice xsi:nil="true" />
            <TransitTime>int</TransitTime>
            <QuoteNumber>string</QuoteNumber>
            <CarrierPerson>string</CarrierPerson>
            <CarrierNote>string</CarrierNote>
            <Datestamp>dateTime</Datestamp>
            <Interline>boolean</Interline>
            <Accepted>boolean</Accepted>
            <CurrencyType>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyType>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <InsuranceDetails xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
          </Quote>
          <Quote>
            <LoadID>int</LoadID>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <ThirdPartyName>string</ThirdPartyName>
            <ThirdPartySCAC>string</ThirdPartySCAC>
            <ServiceID>string</ServiceID>
            <RawPrice xsi:nil="true" />
            <CarrierPrice xsi:nil="true" />
            <CustomerPrice xsi:nil="true" />
            <TransitTime>int</TransitTime>
            <QuoteNumber>string</QuoteNumber>
            <CarrierPerson>string</CarrierPerson>
            <CarrierNote>string</CarrierNote>
            <Datestamp>dateTime</Datestamp>
            <Interline>boolean</Interline>
            <Accepted>boolean</Accepted>
            <CurrencyType>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyType>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <InsuranceDetails xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
          </Quote>
        </Quotes>
        <PendingQuotes>
          <PendingQuote>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <PendingQuoteType>EmailQuote</PendingQuoteType>
            <Datestamp>dateTime</Datestamp>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
          </PendingQuote>
          <PendingQuote>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <PendingQuoteType>EmailQuote</PendingQuoteType>
            <Datestamp>dateTime</Datestamp>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
          </PendingQuote>
        </PendingQuotes>
        <FailedQuotes>
          <FailedQuote>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <ReasonCode>GeneralIssue or Authorization or Account or Tariff or Configuration or ManualRatingRequired or CoverageArea or HazardousMaterial or PackageType or EquipmentType or ShipType or PayType or ShipTypePayTypeCombination or PickupDate or BillTo or FreightClass or MaximumProductThreshold or MissingProductDimensions or MaximumDimensions or ProductDimensions or ProductDescription or NMFC or MaximumWeightThreshold or MinimumWeightThreshold or ShippingUnits or MinimumShippingUnits or MaximumShippingUnits or MissingShipmentDimensions or Shipper or Consignee or ShipperOrConsignee or LimitedAccessType or Accessorial or CODAmount</ReasonCode>
            <Reason>string</Reason>
            <Datestamp>dateTime</Datestamp>
          </FailedQuote>
          <FailedQuote>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <ReasonCode>GeneralIssue or Authorization or Account or Tariff or Configuration or ManualRatingRequired or CoverageArea or HazardousMaterial or PackageType or EquipmentType or ShipType or PayType or ShipTypePayTypeCombination or PickupDate or BillTo or FreightClass or MaximumProductThreshold or MissingProductDimensions or MaximumDimensions or ProductDimensions or ProductDescription or NMFC or MaximumWeightThreshold or MinimumWeightThreshold or ShippingUnits or MinimumShippingUnits or MaximumShippingUnits or MissingShipmentDimensions or Shipper or Consignee or ShipperOrConsignee or LimitedAccessType or Accessorial or CODAmount</ReasonCode>
            <Reason>string</Reason>
            <Datestamp>dateTime</Datestamp>
          </FailedQuote>
        </FailedQuotes>
        <Notes>
          <Note>
            <Text>string</Text>
            <User>string</User>
            <DateStamp>dateTime</DateStamp>
            <NoteType>AccountingAdjustment or Email or Archiving or QuoteUpdate or Carrier or AwardedQuote or TechnicalNote or WebTracking or Edi or SystemEvent or Instructions or Public or BookReason or WebDispatch or QuoteRequest or Private or Contact or Accounting or TerminalUrl or Customer or DockUpdate or Address or DeleteQuote or Package or RateException or BillingReason or AdditionalService or ValidationQuote or QuoteRequestEmail</NoteType>
          </Note>
          <Note>
            <Text>string</Text>
            <User>string</User>
            <DateStamp>dateTime</DateStamp>
            <NoteType>AccountingAdjustment or Email or Archiving or QuoteUpdate or Carrier or AwardedQuote or TechnicalNote or WebTracking or Edi or SystemEvent or Instructions or Public or BookReason or WebDispatch or QuoteRequest or Private or Contact or Accounting or TerminalUrl or Customer or DockUpdate or Address or DeleteQuote or Package or RateException or BillingReason or AdditionalService or ValidationQuote or QuoteRequestEmail</NoteType>
          </Note>
        </Notes>
        <Error>
          <Message>string</Message>
        </Error>
      </UpdateLoadResult>
    </UpdateLoadResponse>
  </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>
    <UpdateLoad xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <AdditionalCustomerMarkup>decimal</AdditionalCustomerMarkup>
        <CustomerCharge>decimal</CustomerCharge>
      </request>
    </UpdateLoad>
  </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>
    <UpdateLoadResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <UpdateLoadResult>
        <Success>boolean</Success>
        <NeedsReRated>boolean</NeedsReRated>
        <ReRateReason>string</ReRateReason>
        <RatingComplete>boolean</RatingComplete>
        <Load>
          <AuthenticationData>
            <Username>string</Username>
            <Password>string</Password>
            <ClientRefNum>string</ClientRefNum>
          </AuthenticationData>
          <DebugMode>boolean</DebugMode>
        </Load>
        <Quotes>
          <Quote>
            <LoadID>int</LoadID>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <ThirdPartyName>string</ThirdPartyName>
            <ThirdPartySCAC>string</ThirdPartySCAC>
            <ServiceID>string</ServiceID>
            <RawPrice xsi:nil="true" />
            <CarrierPrice xsi:nil="true" />
            <CustomerPrice xsi:nil="true" />
            <TransitTime>int</TransitTime>
            <QuoteNumber>string</QuoteNumber>
            <CarrierPerson>string</CarrierPerson>
            <CarrierNote>string</CarrierNote>
            <Datestamp>dateTime</Datestamp>
            <Interline>boolean</Interline>
            <Accepted>boolean</Accepted>
            <CurrencyType>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyType>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <InsuranceDetails xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
          </Quote>
          <Quote>
            <LoadID>int</LoadID>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <ThirdPartyName>string</ThirdPartyName>
            <ThirdPartySCAC>string</ThirdPartySCAC>
            <ServiceID>string</ServiceID>
            <RawPrice xsi:nil="true" />
            <CarrierPrice xsi:nil="true" />
            <CustomerPrice xsi:nil="true" />
            <TransitTime>int</TransitTime>
            <QuoteNumber>string</QuoteNumber>
            <CarrierPerson>string</CarrierPerson>
            <CarrierNote>string</CarrierNote>
            <Datestamp>dateTime</Datestamp>
            <Interline>boolean</Interline>
            <Accepted>boolean</Accepted>
            <CurrencyType>US_Dollar or Canadian_Dollar or Mexican_Peso</CurrencyType>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <InsuranceDetails xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
          </Quote>
        </Quotes>
        <PendingQuotes>
          <PendingQuote>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <PendingQuoteType>EmailQuote</PendingQuoteType>
            <Datestamp>dateTime</Datestamp>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
          </PendingQuote>
          <PendingQuote>
            <QuoteID>int</QuoteID>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <PendingQuoteType>EmailQuote</PendingQuoteType>
            <Datestamp>dateTime</Datestamp>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
          </PendingQuote>
        </PendingQuotes>
        <FailedQuotes>
          <FailedQuote>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <ReasonCode>GeneralIssue or Authorization or Account or Tariff or Configuration or ManualRatingRequired or CoverageArea or HazardousMaterial or PackageType or EquipmentType or ShipType or PayType or ShipTypePayTypeCombination or PickupDate or BillTo or FreightClass or MaximumProductThreshold or MissingProductDimensions or MaximumDimensions or ProductDimensions or ProductDescription or NMFC or MaximumWeightThreshold or MinimumWeightThreshold or ShippingUnits or MinimumShippingUnits or MaximumShippingUnits or MissingShipmentDimensions or Shipper or Consignee or ShipperOrConsignee or LimitedAccessType or Accessorial or CODAmount</ReasonCode>
            <Reason>string</Reason>
            <Datestamp>dateTime</Datestamp>
          </FailedQuote>
          <FailedQuote>
            <CarrierName>string</CarrierName>
            <SCAC>string</SCAC>
            <Service>Parcel or LTL or Volume or Air or Ocean or GFP or LocalCarrier or FTL or Driveaway or Intermodal or Expedite or OceanLCL or AirInternational or InternationalExpedited or DomesticExpedited or Bulk or Rail or Drayage or Scheduled or PartialTruckload or SpotQuote or FinalMile</Service>
            <ReasonCode>GeneralIssue or Authorization or Account or Tariff or Configuration or ManualRatingRequired or CoverageArea or HazardousMaterial or PackageType or EquipmentType or ShipType or PayType or ShipTypePayTypeCombination or PickupDate or BillTo or FreightClass or MaximumProductThreshold or MissingProductDimensions or MaximumDimensions or ProductDimensions or ProductDescription or NMFC or MaximumWeightThreshold or MinimumWeightThreshold or ShippingUnits or MinimumShippingUnits or MaximumShippingUnits or MissingShipmentDimensions or Shipper or Consignee or ShipperOrConsignee or LimitedAccessType or Accessorial or CODAmount</ReasonCode>
            <Reason>string</Reason>
            <Datestamp>dateTime</Datestamp>
          </FailedQuote>
        </FailedQuotes>
        <Notes>
          <Note>
            <Text>string</Text>
            <User>string</User>
            <DateStamp>dateTime</DateStamp>
            <NoteType>AccountingAdjustment or Email or Archiving or QuoteUpdate or Carrier or AwardedQuote or TechnicalNote or WebTracking or Edi or SystemEvent or Instructions or Public or BookReason or WebDispatch or QuoteRequest or Private or Contact or Accounting or TerminalUrl or Customer or DockUpdate or Address or DeleteQuote or Package or RateException or BillingReason or AdditionalService or ValidationQuote or QuoteRequestEmail</NoteType>
          </Note>
          <Note>
            <Text>string</Text>
            <User>string</User>
            <DateStamp>dateTime</DateStamp>
            <NoteType>AccountingAdjustment or Email or Archiving or QuoteUpdate or Carrier or AwardedQuote or TechnicalNote or WebTracking or Edi or SystemEvent or Instructions or Public or BookReason or WebDispatch or QuoteRequest or Private or Contact or Accounting or TerminalUrl or Customer or DockUpdate or Address or DeleteQuote or Package or RateException or BillingReason or AdditionalService or ValidationQuote or QuoteRequestEmail</NoteType>
          </Note>
        </Notes>
        <Error>
          <Message>string</Message>
        </Error>
      </UpdateLoadResult>
    </UpdateLoadResponse>
  </soap12:Body>
</soap12:Envelope>