OnlineOrganization Web Service

OnlineOrganization

Click here for a complete list of operations.

GetTransportOptions

Get options for a set of products.

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 /OnlineOrganization.asmx HTTP/1.1
Host: api.citybreak.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.citybreak.com/GetTransportOptions"

<?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>
    <GetTransportOptions xmlns="http://api.citybreak.com/">
      <productGroupId>int</productGroupId>
      <productIds>
        <int>int</int>
        <int>int</int>
      </productIds>
      <language>string</language>
    </GetTransportOptions>
  </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>
    <GetTransportOptionsResponse xmlns="http://api.citybreak.com/">
      <GetTransportOptionsResult>
        <Pricegroups>
          <TransportPricegroup>
            <Id>string</Id>
            <Name>string</Name>
            <Grouping>string</Grouping>
            <MaxCount>int</MaxCount>
          </TransportPricegroup>
          <TransportPricegroup>
            <Id>string</Id>
            <Name>string</Name>
            <Grouping>string</Grouping>
            <MaxCount>int</MaxCount>
          </TransportPricegroup>
        </Pricegroups>
        <RouteOptions>
          <TransportRouteOption>
            <LocationA xsi:nil="true" />
            <LocationB xsi:nil="true" />
            <IsPreferred>boolean</IsPreferred>
            <IsExcluded>boolean</IsExcluded>
            <AB>boolean</AB>
            <BA>boolean</BA>
            <ABA>boolean</ABA>
            <BAB>boolean</BAB>
            <ABX>boolean</ABX>
            <BAX>boolean</BAX>
            <AXB>boolean</AXB>
            <BXA>boolean</BXA>
            <XAB>boolean</XAB>
            <XBA>boolean</XBA>
          </TransportRouteOption>
          <TransportRouteOption>
            <LocationA xsi:nil="true" />
            <LocationB xsi:nil="true" />
            <IsPreferred>boolean</IsPreferred>
            <IsExcluded>boolean</IsExcluded>
            <AB>boolean</AB>
            <BA>boolean</BA>
            <ABA>boolean</ABA>
            <BAB>boolean</BAB>
            <ABX>boolean</ABX>
            <BAX>boolean</BAX>
            <AXB>boolean</AXB>
            <BXA>boolean</BXA>
            <XAB>boolean</XAB>
            <XBA>boolean</XBA>
          </TransportRouteOption>
        </RouteOptions>
      </GetTransportOptionsResult>
    </GetTransportOptionsResponse>
  </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 /OnlineOrganization.asmx HTTP/1.1
Host: api.citybreak.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>
    <GetTransportOptions xmlns="http://api.citybreak.com/">
      <productGroupId>int</productGroupId>
      <productIds>
        <int>int</int>
        <int>int</int>
      </productIds>
      <language>string</language>
    </GetTransportOptions>
  </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>
    <GetTransportOptionsResponse xmlns="http://api.citybreak.com/">
      <GetTransportOptionsResult>
        <Pricegroups>
          <TransportPricegroup>
            <Id>string</Id>
            <Name>string</Name>
            <Grouping>string</Grouping>
            <MaxCount>int</MaxCount>
          </TransportPricegroup>
          <TransportPricegroup>
            <Id>string</Id>
            <Name>string</Name>
            <Grouping>string</Grouping>
            <MaxCount>int</MaxCount>
          </TransportPricegroup>
        </Pricegroups>
        <RouteOptions>
          <TransportRouteOption>
            <LocationA xsi:nil="true" />
            <LocationB xsi:nil="true" />
            <IsPreferred>boolean</IsPreferred>
            <IsExcluded>boolean</IsExcluded>
            <AB>boolean</AB>
            <BA>boolean</BA>
            <ABA>boolean</ABA>
            <BAB>boolean</BAB>
            <ABX>boolean</ABX>
            <BAX>boolean</BAX>
            <AXB>boolean</AXB>
            <BXA>boolean</BXA>
            <XAB>boolean</XAB>
            <XBA>boolean</XBA>
          </TransportRouteOption>
          <TransportRouteOption>
            <LocationA xsi:nil="true" />
            <LocationB xsi:nil="true" />
            <IsPreferred>boolean</IsPreferred>
            <IsExcluded>boolean</IsExcluded>
            <AB>boolean</AB>
            <BA>boolean</BA>
            <ABA>boolean</ABA>
            <BAB>boolean</BAB>
            <ABX>boolean</ABX>
            <BAX>boolean</BAX>
            <AXB>boolean</AXB>
            <BXA>boolean</BXA>
            <XAB>boolean</XAB>
            <XBA>boolean</XBA>
          </TransportRouteOption>
        </RouteOptions>
      </GetTransportOptionsResult>
    </GetTransportOptionsResponse>
  </soap12:Body>
</soap12:Envelope>