ConnectivityPlatform

Click here for a complete list of operations.

CreateCarrierSubscription

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

<?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>
    <CreateCarrierSubscription xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <CarrierInfo>
          <SCAC>string</SCAC>
          <ServiceMode>string</ServiceMode>
          <CarrierCredentials>
            <KeyValuePairOfStringString xsi:nil="true" />
            <KeyValuePairOfStringString xsi:nil="true" />
          </CarrierCredentials>
        </CarrierInfo>
        <Accounts>
          <AccountInfo>
            <AccountNumber>string</AccountNumber>
            <Note>string</Note>
            <ShipperEnabled>boolean</ShipperEnabled>
            <ConsigneeEnabled>boolean</ConsigneeEnabled>
            <ThirdPartyEnabled>boolean</ThirdPartyEnabled>
            <RatingType>string</RatingType>
          </AccountInfo>
          <AccountInfo>
            <AccountNumber>string</AccountNumber>
            <Note>string</Note>
            <ShipperEnabled>boolean</ShipperEnabled>
            <ConsigneeEnabled>boolean</ConsigneeEnabled>
            <ThirdPartyEnabled>boolean</ThirdPartyEnabled>
            <RatingType>string</RatingType>
          </AccountInfo>
        </Accounts>
        <SubscriptionSettings>
          <DisplayName>string</DisplayName>
        </SubscriptionSettings>
        <SubRefNum>string</SubRefNum>
        <Blanket>boolean</Blanket>
      </request>
    </CreateCarrierSubscription>
  </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>
    <CreateCarrierSubscriptionResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <CreateCarrierSubscriptionResult>
        <Success>boolean</Success>
        <Error>string</Error>
        <SubscriptionReferenceNumber>string</SubscriptionReferenceNumber>
      </CreateCarrierSubscriptionResult>
    </CreateCarrierSubscriptionResponse>
  </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>
    <CreateCarrierSubscription xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <request>
        <AuthenticationData>
          <Username>string</Username>
          <Password>string</Password>
          <ClientRefNum>string</ClientRefNum>
        </AuthenticationData>
        <CarrierInfo>
          <SCAC>string</SCAC>
          <ServiceMode>string</ServiceMode>
          <CarrierCredentials>
            <KeyValuePairOfStringString xsi:nil="true" />
            <KeyValuePairOfStringString xsi:nil="true" />
          </CarrierCredentials>
        </CarrierInfo>
        <Accounts>
          <AccountInfo>
            <AccountNumber>string</AccountNumber>
            <Note>string</Note>
            <ShipperEnabled>boolean</ShipperEnabled>
            <ConsigneeEnabled>boolean</ConsigneeEnabled>
            <ThirdPartyEnabled>boolean</ThirdPartyEnabled>
            <RatingType>string</RatingType>
          </AccountInfo>
          <AccountInfo>
            <AccountNumber>string</AccountNumber>
            <Note>string</Note>
            <ShipperEnabled>boolean</ShipperEnabled>
            <ConsigneeEnabled>boolean</ConsigneeEnabled>
            <ThirdPartyEnabled>boolean</ThirdPartyEnabled>
            <RatingType>string</RatingType>
          </AccountInfo>
        </Accounts>
        <SubscriptionSettings>
          <DisplayName>string</DisplayName>
        </SubscriptionSettings>
        <SubRefNum>string</SubRefNum>
        <Blanket>boolean</Blanket>
      </request>
    </CreateCarrierSubscription>
  </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>
    <CreateCarrierSubscriptionResponse xmlns="http://www.banyantechnology.com/Services/ConnectivityPlatform/">
      <CreateCarrierSubscriptionResult>
        <Success>boolean</Success>
        <Error>string</Error>
        <SubscriptionReferenceNumber>string</SubscriptionReferenceNumber>
      </CreateCarrierSubscriptionResult>
    </CreateCarrierSubscriptionResponse>
  </soap12:Body>
</soap12:Envelope>