OnlineInstance Web Service

OnlineInstance

Click here for a complete list of operations.

GetOnlineSettings

Get online settings

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

<?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>
    <GetOnlineSettings xmlns="http://api.citybreak.com/" />
  </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>
    <GetOnlineSettingsResponse xmlns="http://api.citybreak.com/">
      <GetOnlineSettingsResult>
        <Adform>
          <UseAdform>boolean</UseAdform>
          <AccountId>string</AccountId>
          <AccommodationStart>string</AccommodationStart>
          <AccommodationStepTwo>string</AccommodationStepTwo>
          <AccommodationConfirmation>string</AccommodationConfirmation>
          <PackageStart>string</PackageStart>
          <PackageStepTwo>string</PackageStepTwo>
          <PackageConfirmation>string</PackageConfirmation>
          <ActivityStart>string</ActivityStart>
          <ActivityConfirm>string</ActivityConfirm>
        </Adform>
        <AdsFac>
          <UseAdsFacTracker>boolean</UseAdsFacTracker>
          <PackageConfirmationAccount>string</PackageConfirmationAccount>
          <AccommodationConfirmationAccount>string</AccommodationConfirmationAccount>
          <OtherConfirmationAccount>string</OtherConfirmationAccount>
          <TransportConfirmationAccount>string</TransportConfirmationAccount>
          <PackagePaymentAccount>string</PackagePaymentAccount>
          <AccommodationPaymentAccount>string</AccommodationPaymentAccount>
          <OtherPaymentAccount>string</OtherPaymentAccount>
          <TransportPaymentAccount>string</TransportPaymentAccount>
        </AdsFac>
        <Google>
          <UseGoogleTracker>boolean</UseGoogleTracker>
          <GoogleAccount>string</GoogleAccount>
          <GoogleDomain>string</GoogleDomain>
          <UniversalAnalytics>boolean</UniversalAnalytics>
        </Google>
        <TradeDoubler>
          <UseTracker>boolean</UseTracker>
          <Organization>string</Organization>
          <Event>string</Event>
          <Secret>string</Secret>
        </TradeDoubler>
        <WhatsOn>
          <UseWhatsOn>boolean</UseWhatsOn>
          <OrganizationId>int</OrganizationId>
          <ExcludeCategoryIds>
            <int>int</int>
            <int>int</int>
          </ExcludeCategoryIds>
        </WhatsOn>
        <AllBookingSettings>
          <BookingSettings>
            <BookHoursBeforeArrival>int</BookHoursBeforeArrival>
            <CancelBookHoursBeforeArrival>int</CancelBookHoursBeforeArrival>
            <PropType>ProducttypegroupHotel or ProducttypegroupCabin or ProducttypegroupHostel or ProducttypegroupBednbreakfast or ProducttypegroupApartment or ProducttypegroupOther or ProducttypegroupGuesthouse or ProducttypegroupCamping or ProducttypegroupPrivateCabin or ProducttypegroupGameReserve or ProducttypegroupHolidayHouses or ProducttypegroupExternal</PropType>
          </BookingSettings>
          <BookingSettings>
            <BookHoursBeforeArrival>int</BookHoursBeforeArrival>
            <CancelBookHoursBeforeArrival>int</CancelBookHoursBeforeArrival>
            <PropType>ProducttypegroupHotel or ProducttypegroupCabin or ProducttypegroupHostel or ProducttypegroupBednbreakfast or ProducttypegroupApartment or ProducttypegroupOther or ProducttypegroupGuesthouse or ProducttypegroupCamping or ProducttypegroupPrivateCabin or ProducttypegroupGameReserve or ProducttypegroupHolidayHouses or ProducttypegroupExternal</PropType>
          </BookingSettings>
        </AllBookingSettings>
        <HeadlightTracker>
          <AccountId>string</AccountId>
          <UseTracker>boolean</UseTracker>
          <PartnerId>string</PartnerId>
        </HeadlightTracker>
        <RequireOptionalCellPhone>boolean</RequireOptionalCellPhone>
        <IconScheeme>Black or STF</IconScheeme>
        <ShowNewBookingWhenLogedIn>boolean</ShowNewBookingWhenLogedIn>
        <GuideSettings>
          <SortAlpha>boolean</SortAlpha>
          <SortRandom>boolean</SortRandom>
          <SortRating>boolean</SortRating>
          <SortDefault>Alpha or Random or Price or Rating</SortDefault>
        </GuideSettings>
        <PaymentDigest>boolean</PaymentDigest>
        <PaymentCustomernumber>boolean</PaymentCustomernumber>
        <MayCancelBookings>boolean</MayCancelBookings>
        <PaymentDefaultNoCountry>boolean</PaymentDefaultNoCountry>
        <ShowAllCustomerFields>boolean</ShowAllCustomerFields>
        <RequireAllCustomerFields>boolean</RequireAllCustomerFields>
        <ShowVisitLink>boolean</ShowVisitLink>
        <HideFromSearchEngines>boolean</HideFromSearchEngines>
        <CorporateEnabled>boolean</CorporateEnabled>
        <MapAvailableWhenListingOtherProducts>boolean</MapAvailableWhenListingOtherProducts>
        <TrackingUseHbx>boolean</TrackingUseHbx>
        <TrackingHbxAccount>string</TrackingHbxAccount>
        <TrackingHbxGateway>string</TrackingHbxGateway>
        <TrackingHbxLinkTracking>None or Auto</TrackingHbxLinkTracking>
        <UseDoubleClickSpotlight>boolean</UseDoubleClickSpotlight>
        <UseRatecodeCancellation>boolean</UseRatecodeCancellation>
        <Show360Link>boolean</Show360Link>
        <UseAlternativeAccPage>boolean</UseAlternativeAccPage>
        <ShowAlternativeAccPage>boolean</ShowAlternativeAccPage>
        <PackageTicketTypeVisible>boolean</PackageTicketTypeVisible>
        <MayChangeBooking>boolean</MayChangeBooking>
        <MustConfirmRatecodeTerms>boolean</MustConfirmRatecodeTerms>
        <MustConfirmSecurityAndPrivacy>boolean</MustConfirmSecurityAndPrivacy>
        <OtherBookHoursLates>int</OtherBookHoursLates>
        <HotelContactView>
          <AddressVisible>boolean</AddressVisible>
          <PhoneVisible>boolean</PhoneVisible>
          <EmailVisible>boolean</EmailVisible>
          <DirectionsVisible>boolean</DirectionsVisible>
          <HomepageVisible>boolean</HomepageVisible>
        </HotelContactView>
        <BlockPayLaterOption>boolean</BlockPayLaterOption>
        <MapExternalLink>boolean</MapExternalLink>
        <MustConfirmTerms>boolean</MustConfirmTerms>
        <CorpCustomerInvoice>boolean</CorpCustomerInvoice>
        <OnlyBookableInAccommodationGuide>boolean</OnlyBookableInAccommodationGuide>
        <OtherProductsAfteraccommodation>boolean</OtherProductsAfteraccommodation>
        <SpecificAccommodationSearchAvailable>boolean</SpecificAccommodationSearchAvailable>
        <AdvancedSearchVisible>boolean</AdvancedSearchVisible>
        <EnableHostelBedSearch>boolean</EnableHostelBedSearch>
        <ShowTopAccommodationSearchMenu>boolean</ShowTopAccommodationSearchMenu>
        <AllowAllOnListAccommodation>boolean</AllowAllOnListAccommodation>
        <HomeVisible>boolean</HomeVisible>
        <RoomPopupStyle>Oldschool or Cabilstyle</RoomPopupStyle>
        <DefaultSearchFormForLoggedInUser>DefaultBehaviour or Package or Accommodation or Event or Transportation or Activity or Other or Golf or Merchandise</DefaultSearchFormForLoggedInUser>
        <OtherProductDisplay>Product or ProductGroup</OtherProductDisplay>
        <ImageSettings>
          <IconScheeme>Regular or White or Style1</IconScheeme>
          <IconSchemeString>string</IconSchemeString>
        </ImageSettings>
        <VoucherLinks>boolean</VoucherLinks>
        <UseCountry>boolean</UseCountry>
        <RequireCountry>boolean</RequireCountry>
        <UseCompany>boolean</UseCompany>
        <RequireCompany>boolean</RequireCompany>
        <UseCustomernumber>boolean</UseCustomernumber>
        <RequireCustomernumber>boolean</RequireCustomernumber>
        <UseSalution>boolean</UseSalution>
        <RequireSalution>boolean</RequireSalution>
        <UseFirstname>boolean</UseFirstname>
        <RequireFirstname>boolean</RequireFirstname>
        <UseLastname>boolean</UseLastname>
        <RequireLastname>boolean</RequireLastname>
        <UseCivic>boolean</UseCivic>
        <RequireCivic>boolean</RequireCivic>
        <UseAddress1>boolean</UseAddress1>
        <RequireAddress1>boolean</RequireAddress1>
        <UseAddress2>boolean</UseAddress2>
        <RequireAddress2>boolean</RequireAddress2>
        <UsePostalCode>boolean</UsePostalCode>
        <RequirePostalCode>boolean</RequirePostalCode>
        <UseCity>boolean</UseCity>
        <RequireCity>boolean</RequireCity>
        <UsePhoneNumber>boolean</UsePhoneNumber>
        <RequirePhoneNumber>boolean</RequirePhoneNumber>
        <UseCellPhoneNumber>boolean</UseCellPhoneNumber>
        <RequireCellPhoneNumber>boolean</RequireCellPhoneNumber>
        <UseFaxNumber>boolean</UseFaxNumber>
        <RequireFaxNumber>boolean</RequireFaxNumber>
        <UseEmail>boolean</UseEmail>
        <RequireEmail>boolean</RequireEmail>
        <UseReferenceSalution>boolean</UseReferenceSalution>
        <RequireReferenceSalution>boolean</RequireReferenceSalution>
        <UseReferenceName>boolean</UseReferenceName>
        <RequireReferenceName>boolean</RequireReferenceName>
        <UseReferenceEmail>boolean</UseReferenceEmail>
        <RequireReferenceEmail>boolean</RequireReferenceEmail>
        <UseReferenceDropDown>boolean</UseReferenceDropDown>
        <MandatoryCustomersField>boolean</MandatoryCustomersField>
        <UseLoginFields>boolean</UseLoginFields>
        <UseFirstTime>boolean</UseFirstTime>
        <ShowGuestInfo>boolean</ShowGuestInfo>
        <ShowRequestAndArrival>boolean</ShowRequestAndArrival>
        <ShowTotalPriceBottom>boolean</ShowTotalPriceBottom>
        <ShowMapTabAccDetails>boolean</ShowMapTabAccDetails>
        <ShowStepCounter>boolean</ShowStepCounter>
        <ShowStepCounterSearchTab>boolean</ShowStepCounterSearchTab>
        <ShowMapResults>boolean</ShowMapResults>
        <MultisearchAllowAllGeoNodes>boolean</MultisearchAllowAllGeoNodes>
        <MultiSearchResultDefaultOnMap>boolean</MultiSearchResultDefaultOnMap>
        <MoveToOnline2>boolean</MoveToOnline2>
        <MoveToOnline3>boolean</MoveToOnline3>
        <UseHttps>boolean</UseHttps>
        <TravellerRatingShowOwnerAuthorName>boolean</TravellerRatingShowOwnerAuthorName>
      </GetOnlineSettingsResult>
    </GetOnlineSettingsResponse>
  </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 /OnlineInstance.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>
    <GetOnlineSettings xmlns="http://api.citybreak.com/" />
  </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>
    <GetOnlineSettingsResponse xmlns="http://api.citybreak.com/">
      <GetOnlineSettingsResult>
        <Adform>
          <UseAdform>boolean</UseAdform>
          <AccountId>string</AccountId>
          <AccommodationStart>string</AccommodationStart>
          <AccommodationStepTwo>string</AccommodationStepTwo>
          <AccommodationConfirmation>string</AccommodationConfirmation>
          <PackageStart>string</PackageStart>
          <PackageStepTwo>string</PackageStepTwo>
          <PackageConfirmation>string</PackageConfirmation>
          <ActivityStart>string</ActivityStart>
          <ActivityConfirm>string</ActivityConfirm>
        </Adform>
        <AdsFac>
          <UseAdsFacTracker>boolean</UseAdsFacTracker>
          <PackageConfirmationAccount>string</PackageConfirmationAccount>
          <AccommodationConfirmationAccount>string</AccommodationConfirmationAccount>
          <OtherConfirmationAccount>string</OtherConfirmationAccount>
          <TransportConfirmationAccount>string</TransportConfirmationAccount>
          <PackagePaymentAccount>string</PackagePaymentAccount>
          <AccommodationPaymentAccount>string</AccommodationPaymentAccount>
          <OtherPaymentAccount>string</OtherPaymentAccount>
          <TransportPaymentAccount>string</TransportPaymentAccount>
        </AdsFac>
        <Google>
          <UseGoogleTracker>boolean</UseGoogleTracker>
          <GoogleAccount>string</GoogleAccount>
          <GoogleDomain>string</GoogleDomain>
          <UniversalAnalytics>boolean</UniversalAnalytics>
        </Google>
        <TradeDoubler>
          <UseTracker>boolean</UseTracker>
          <Organization>string</Organization>
          <Event>string</Event>
          <Secret>string</Secret>
        </TradeDoubler>
        <WhatsOn>
          <UseWhatsOn>boolean</UseWhatsOn>
          <OrganizationId>int</OrganizationId>
          <ExcludeCategoryIds>
            <int>int</int>
            <int>int</int>
          </ExcludeCategoryIds>
        </WhatsOn>
        <AllBookingSettings>
          <BookingSettings>
            <BookHoursBeforeArrival>int</BookHoursBeforeArrival>
            <CancelBookHoursBeforeArrival>int</CancelBookHoursBeforeArrival>
            <PropType>ProducttypegroupHotel or ProducttypegroupCabin or ProducttypegroupHostel or ProducttypegroupBednbreakfast or ProducttypegroupApartment or ProducttypegroupOther or ProducttypegroupGuesthouse or ProducttypegroupCamping or ProducttypegroupPrivateCabin or ProducttypegroupGameReserve or ProducttypegroupHolidayHouses or ProducttypegroupExternal</PropType>
          </BookingSettings>
          <BookingSettings>
            <BookHoursBeforeArrival>int</BookHoursBeforeArrival>
            <CancelBookHoursBeforeArrival>int</CancelBookHoursBeforeArrival>
            <PropType>ProducttypegroupHotel or ProducttypegroupCabin or ProducttypegroupHostel or ProducttypegroupBednbreakfast or ProducttypegroupApartment or ProducttypegroupOther or ProducttypegroupGuesthouse or ProducttypegroupCamping or ProducttypegroupPrivateCabin or ProducttypegroupGameReserve or ProducttypegroupHolidayHouses or ProducttypegroupExternal</PropType>
          </BookingSettings>
        </AllBookingSettings>
        <HeadlightTracker>
          <AccountId>string</AccountId>
          <UseTracker>boolean</UseTracker>
          <PartnerId>string</PartnerId>
        </HeadlightTracker>
        <RequireOptionalCellPhone>boolean</RequireOptionalCellPhone>
        <IconScheeme>Black or STF</IconScheeme>
        <ShowNewBookingWhenLogedIn>boolean</ShowNewBookingWhenLogedIn>
        <GuideSettings>
          <SortAlpha>boolean</SortAlpha>
          <SortRandom>boolean</SortRandom>
          <SortRating>boolean</SortRating>
          <SortDefault>Alpha or Random or Price or Rating</SortDefault>
        </GuideSettings>
        <PaymentDigest>boolean</PaymentDigest>
        <PaymentCustomernumber>boolean</PaymentCustomernumber>
        <MayCancelBookings>boolean</MayCancelBookings>
        <PaymentDefaultNoCountry>boolean</PaymentDefaultNoCountry>
        <ShowAllCustomerFields>boolean</ShowAllCustomerFields>
        <RequireAllCustomerFields>boolean</RequireAllCustomerFields>
        <ShowVisitLink>boolean</ShowVisitLink>
        <HideFromSearchEngines>boolean</HideFromSearchEngines>
        <CorporateEnabled>boolean</CorporateEnabled>
        <MapAvailableWhenListingOtherProducts>boolean</MapAvailableWhenListingOtherProducts>
        <TrackingUseHbx>boolean</TrackingUseHbx>
        <TrackingHbxAccount>string</TrackingHbxAccount>
        <TrackingHbxGateway>string</TrackingHbxGateway>
        <TrackingHbxLinkTracking>None or Auto</TrackingHbxLinkTracking>
        <UseDoubleClickSpotlight>boolean</UseDoubleClickSpotlight>
        <UseRatecodeCancellation>boolean</UseRatecodeCancellation>
        <Show360Link>boolean</Show360Link>
        <UseAlternativeAccPage>boolean</UseAlternativeAccPage>
        <ShowAlternativeAccPage>boolean</ShowAlternativeAccPage>
        <PackageTicketTypeVisible>boolean</PackageTicketTypeVisible>
        <MayChangeBooking>boolean</MayChangeBooking>
        <MustConfirmRatecodeTerms>boolean</MustConfirmRatecodeTerms>
        <MustConfirmSecurityAndPrivacy>boolean</MustConfirmSecurityAndPrivacy>
        <OtherBookHoursLates>int</OtherBookHoursLates>
        <HotelContactView>
          <AddressVisible>boolean</AddressVisible>
          <PhoneVisible>boolean</PhoneVisible>
          <EmailVisible>boolean</EmailVisible>
          <DirectionsVisible>boolean</DirectionsVisible>
          <HomepageVisible>boolean</HomepageVisible>
        </HotelContactView>
        <BlockPayLaterOption>boolean</BlockPayLaterOption>
        <MapExternalLink>boolean</MapExternalLink>
        <MustConfirmTerms>boolean</MustConfirmTerms>
        <CorpCustomerInvoice>boolean</CorpCustomerInvoice>
        <OnlyBookableInAccommodationGuide>boolean</OnlyBookableInAccommodationGuide>
        <OtherProductsAfteraccommodation>boolean</OtherProductsAfteraccommodation>
        <SpecificAccommodationSearchAvailable>boolean</SpecificAccommodationSearchAvailable>
        <AdvancedSearchVisible>boolean</AdvancedSearchVisible>
        <EnableHostelBedSearch>boolean</EnableHostelBedSearch>
        <ShowTopAccommodationSearchMenu>boolean</ShowTopAccommodationSearchMenu>
        <AllowAllOnListAccommodation>boolean</AllowAllOnListAccommodation>
        <HomeVisible>boolean</HomeVisible>
        <RoomPopupStyle>Oldschool or Cabilstyle</RoomPopupStyle>
        <DefaultSearchFormForLoggedInUser>DefaultBehaviour or Package or Accommodation or Event or Transportation or Activity or Other or Golf or Merchandise</DefaultSearchFormForLoggedInUser>
        <OtherProductDisplay>Product or ProductGroup</OtherProductDisplay>
        <ImageSettings>
          <IconScheeme>Regular or White or Style1</IconScheeme>
          <IconSchemeString>string</IconSchemeString>
        </ImageSettings>
        <VoucherLinks>boolean</VoucherLinks>
        <UseCountry>boolean</UseCountry>
        <RequireCountry>boolean</RequireCountry>
        <UseCompany>boolean</UseCompany>
        <RequireCompany>boolean</RequireCompany>
        <UseCustomernumber>boolean</UseCustomernumber>
        <RequireCustomernumber>boolean</RequireCustomernumber>
        <UseSalution>boolean</UseSalution>
        <RequireSalution>boolean</RequireSalution>
        <UseFirstname>boolean</UseFirstname>
        <RequireFirstname>boolean</RequireFirstname>
        <UseLastname>boolean</UseLastname>
        <RequireLastname>boolean</RequireLastname>
        <UseCivic>boolean</UseCivic>
        <RequireCivic>boolean</RequireCivic>
        <UseAddress1>boolean</UseAddress1>
        <RequireAddress1>boolean</RequireAddress1>
        <UseAddress2>boolean</UseAddress2>
        <RequireAddress2>boolean</RequireAddress2>
        <UsePostalCode>boolean</UsePostalCode>
        <RequirePostalCode>boolean</RequirePostalCode>
        <UseCity>boolean</UseCity>
        <RequireCity>boolean</RequireCity>
        <UsePhoneNumber>boolean</UsePhoneNumber>
        <RequirePhoneNumber>boolean</RequirePhoneNumber>
        <UseCellPhoneNumber>boolean</UseCellPhoneNumber>
        <RequireCellPhoneNumber>boolean</RequireCellPhoneNumber>
        <UseFaxNumber>boolean</UseFaxNumber>
        <RequireFaxNumber>boolean</RequireFaxNumber>
        <UseEmail>boolean</UseEmail>
        <RequireEmail>boolean</RequireEmail>
        <UseReferenceSalution>boolean</UseReferenceSalution>
        <RequireReferenceSalution>boolean</RequireReferenceSalution>
        <UseReferenceName>boolean</UseReferenceName>
        <RequireReferenceName>boolean</RequireReferenceName>
        <UseReferenceEmail>boolean</UseReferenceEmail>
        <RequireReferenceEmail>boolean</RequireReferenceEmail>
        <UseReferenceDropDown>boolean</UseReferenceDropDown>
        <MandatoryCustomersField>boolean</MandatoryCustomersField>
        <UseLoginFields>boolean</UseLoginFields>
        <UseFirstTime>boolean</UseFirstTime>
        <ShowGuestInfo>boolean</ShowGuestInfo>
        <ShowRequestAndArrival>boolean</ShowRequestAndArrival>
        <ShowTotalPriceBottom>boolean</ShowTotalPriceBottom>
        <ShowMapTabAccDetails>boolean</ShowMapTabAccDetails>
        <ShowStepCounter>boolean</ShowStepCounter>
        <ShowStepCounterSearchTab>boolean</ShowStepCounterSearchTab>
        <ShowMapResults>boolean</ShowMapResults>
        <MultisearchAllowAllGeoNodes>boolean</MultisearchAllowAllGeoNodes>
        <MultiSearchResultDefaultOnMap>boolean</MultiSearchResultDefaultOnMap>
        <MoveToOnline2>boolean</MoveToOnline2>
        <MoveToOnline3>boolean</MoveToOnline3>
        <UseHttps>boolean</UseHttps>
        <TravellerRatingShowOwnerAuthorName>boolean</TravellerRatingShowOwnerAuthorName>
      </GetOnlineSettingsResult>
    </GetOnlineSettingsResponse>
  </soap12:Body>
</soap12:Envelope>