OnlineInstance


Click here for a complete list of operations.

GetOnlineMessages

Get configured online messages. Used to display at certain points depending on type. Administrated in Citybreak� Professional.

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

<?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>
    <GetOnlineMessages xmlns="http://api.citybreak.com/">
      <etype>WelcomeText or ConfirmedThankYou or BookInstruction or PersonalService or PersonalGreeting or TermsAndConditions or HowToCancel or OtherProductListHeadLine or OtherProductListIntroduction or PasswordRecovery or PasswordRecoveryEnd or PasswordRecoverySubject or SearchHeaderText or ListHeaderText or OtherProductBookInstruction or PaymentNote or CreditCardNote or InvoiceNote or ComplementaryNote or BasketPromotionHeader or BasketPromotionText or PropertyArrivalTimeDisclaimer or GuestConfigurationText or NoAvailabilityFound or PackageLightList or PrivacyText or BankTransferNote or CreditCardTransferNote or HowToLogin or PackageListHeader or PackageListIntroduction or SecurityCode or Online3AccommodationGuideListing or Online3CabinGuideListing or Online3TodoGuideListing or BookWithUsHeader or BookWithUsText or CustomerServiceHeader or CustomerServiceText or BasketDescription or BasketSidebarBox or PaymentDetailsDescription or ImportantMessageBanner or ImportantMessageReadMore or PayOnSiteAccommodationMessage or PayOnSiteCarRentalMessage or LoyaltyLoginMembershipMessage</etype>
    </GetOnlineMessages>
  </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>
    <GetOnlineMessagesResponse xmlns="http://api.citybreak.com/">
      <GetOnlineMessagesResult>
        <OnlineId>int</OnlineId>
        <SystemTypeId>WelcomeText or ConfirmedThankYou or BookInstruction or PersonalService or PersonalGreeting or TermsAndConditions or HowToCancel or OtherProductListHeadLine or OtherProductListIntroduction or PasswordRecovery or PasswordRecoveryEnd or PasswordRecoverySubject or SearchHeaderText or ListHeaderText or OtherProductBookInstruction or PaymentNote or CreditCardNote or InvoiceNote or ComplementaryNote or BasketPromotionHeader or BasketPromotionText or PropertyArrivalTimeDisclaimer or GuestConfigurationText or NoAvailabilityFound or PackageLightList or PrivacyText or BankTransferNote or CreditCardTransferNote or HowToLogin or PackageListHeader or PackageListIntroduction or SecurityCode or Online3AccommodationGuideListing or Online3CabinGuideListing or Online3TodoGuideListing or BookWithUsHeader or BookWithUsText or CustomerServiceHeader or CustomerServiceText or BasketDescription or BasketSidebarBox or PaymentDetailsDescription or ImportantMessageBanner or ImportantMessageReadMore or PayOnSiteAccommodationMessage or PayOnSiteCarRentalMessage or LoyaltyLoginMembershipMessage</SystemTypeId>
        <Message>string</Message>
      </GetOnlineMessagesResult>
    </GetOnlineMessagesResponse>
  </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>
    <GetOnlineMessages xmlns="http://api.citybreak.com/">
      <etype>WelcomeText or ConfirmedThankYou or BookInstruction or PersonalService or PersonalGreeting or TermsAndConditions or HowToCancel or OtherProductListHeadLine or OtherProductListIntroduction or PasswordRecovery or PasswordRecoveryEnd or PasswordRecoverySubject or SearchHeaderText or ListHeaderText or OtherProductBookInstruction or PaymentNote or CreditCardNote or InvoiceNote or ComplementaryNote or BasketPromotionHeader or BasketPromotionText or PropertyArrivalTimeDisclaimer or GuestConfigurationText or NoAvailabilityFound or PackageLightList or PrivacyText or BankTransferNote or CreditCardTransferNote or HowToLogin or PackageListHeader or PackageListIntroduction or SecurityCode or Online3AccommodationGuideListing or Online3CabinGuideListing or Online3TodoGuideListing or BookWithUsHeader or BookWithUsText or CustomerServiceHeader or CustomerServiceText or BasketDescription or BasketSidebarBox or PaymentDetailsDescription or ImportantMessageBanner or ImportantMessageReadMore or PayOnSiteAccommodationMessage or PayOnSiteCarRentalMessage or LoyaltyLoginMembershipMessage</etype>
    </GetOnlineMessages>
  </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>
    <GetOnlineMessagesResponse xmlns="http://api.citybreak.com/">
      <GetOnlineMessagesResult>
        <OnlineId>int</OnlineId>
        <SystemTypeId>WelcomeText or ConfirmedThankYou or BookInstruction or PersonalService or PersonalGreeting or TermsAndConditions or HowToCancel or OtherProductListHeadLine or OtherProductListIntroduction or PasswordRecovery or PasswordRecoveryEnd or PasswordRecoverySubject or SearchHeaderText or ListHeaderText or OtherProductBookInstruction or PaymentNote or CreditCardNote or InvoiceNote or ComplementaryNote or BasketPromotionHeader or BasketPromotionText or PropertyArrivalTimeDisclaimer or GuestConfigurationText or NoAvailabilityFound or PackageLightList or PrivacyText or BankTransferNote or CreditCardTransferNote or HowToLogin or PackageListHeader or PackageListIntroduction or SecurityCode or Online3AccommodationGuideListing or Online3CabinGuideListing or Online3TodoGuideListing or BookWithUsHeader or BookWithUsText or CustomerServiceHeader or CustomerServiceText or BasketDescription or BasketSidebarBox or PaymentDetailsDescription or ImportantMessageBanner or ImportantMessageReadMore or PayOnSiteAccommodationMessage or PayOnSiteCarRentalMessage or LoyaltyLoginMembershipMessage</SystemTypeId>
        <Message>string</Message>
      </GetOnlineMessagesResult>
    </GetOnlineMessagesResponse>
  </soap12:Body>
</soap12:Envelope>