ContentService

Content Service SOAP WSDL

ActivateProperty

Activate a Property

ActivatePropertyResponse ActivateProperty(ActivatePropertyRequest request)

Method Parameters

Field Data Type Description
requestActivatePropertyRequest

ActivatePropertyRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

ActivatePropertyResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not. The ActivationFailureFault Fault will be thrown if not.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

AddAPImage

DirectAPIAddAPImage_Response AddAPImage(DirectAPIAddAPImageRequest request)

Method Parameters

Field Data Type Description
requestDirectAPIAddAPImageRequest

DirectAPIAddAPImageRequest

Field Data Type Description
LargeImageDataStringBase64 encoded dump of the image data, eg the contents of a jpg file
LargeImageFileNameStringThe Filename for this image, not this is not the URL but just the Filename and extension. It should not contain the directory path either.
ToolTipTextStringWhen the mouse cursor hovers over this image in the website(s), what hover text should be displayed to describe this image to the user.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DirectAPIAddAPImage_Response

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelImageIDInt64Unique identifier for this image
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

CopyHotelRatePackage

CopyHotelRatePackage is used to Delete a Room for a hotel.

CopyHotelRatePackageResponse CopyHotelRatePackage(CopyHotelRatePackageRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestCopyHotelRatePackageRequest

CopyHotelRatePackageRequest

Field Data Type Description
HotelRatePackageIdInt64The Hotel Rate Package Id of the Hotel Rate Package you wish to Copy.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

CopyHotelRatePackageResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeActivateProperty

DeActivate a Property

DeActivatePropertyResponse DeActivateProperty(DeActivatePropertyRequest request)

Method Parameters

Field Data Type Description
requestDeActivatePropertyRequest

DeActivatePropertyRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DeActivatePropertyResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not. The DeActivationFailureFault Fault will be thrown if not.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteBookingQuestion

DeleteBookingQuestion is used to remove an extra from a hotel

DeleteBookingQuestionResponse DeleteBookingQuestion(DeleteBookingQuestionRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestDeleteBookingQuestionRequest

DeleteBookingQuestionRequest

Field Data Type Description
BookingQuestionIdInt64The Booking Questions to be deleted
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DeleteBookingQuestionResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteHotelBathroom

DelHotelBathroomResponse DeleteHotelBathroom(DelHotelBathroomRequest request)

Method Parameters

Field Data Type Description
requestDelHotelBathroomRequest

DelHotelBathroomRequest

Field Data Type Description
HotelBathroomsHotelBathrooms
RoomTypeIdInt64
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelBathrooms

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

TimeSpan

Field Data Type Description

DelHotelBathroomResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteHotelBedConfig

DelHotelBedConfigResponse DeleteHotelBedConfig(DelHotelBedConfigRequest request)

Method Parameters

Field Data Type Description
requestDelHotelBedConfigRequest

DelHotelBedConfigRequest

Field Data Type Description
HotelBedConfigsHotelBedConfig
RoomTypeIdInt64
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelBedConfig

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

TimeSpan

Field Data Type Description

DelHotelBedConfigResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteHotelBedroom

DelHotelBedroomResponse DeleteHotelBedroom(DelHotelBedroomRequest request)

Method Parameters

Field Data Type Description
requestDelHotelBedroomRequest

DelHotelBedroomRequest

Field Data Type Description
HotelBedroomsHotelBedroom
RoomTypeIdInt64
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelBedroom

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

TimeSpan

Field Data Type Description

DelHotelBedroomResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteHotelDCFees

delete distribution fees for a hotel

DeleteHotelDCFeesResponse DeleteHotelDCFees(DeleteHotelDCFeesRequest request)

Method Parameters

Field Data Type Description
requestDeleteHotelDCFeesRequest

DeleteHotelDCFeesRequest

Field Data Type Description
DistributionChannelCodeStringThe unique code for the distribution channel.
FeeIdsList of Int64
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DeleteHotelDCFeesResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
FeesAffectedList of Int64All room ids affected are returned here. If you create a new room the ID will also be in here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteHotelExtra

DeleteHotelExtra is used to remove an extra from a hotel

HotelExtraDeleteResponse DeleteHotelExtra(HotelExtraDeleteRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestHotelExtraDeleteRequest

HotelExtraDeleteRequest

Field Data Type Description
HotelExtraIdInt64The hotel extra to be deleted
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

HotelExtraDeleteResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteHotelRentalAgreement

Delete Rental Agreement for a hotel

DelRentalAgreementResponse DeleteHotelRentalAgreement(DelRentalAgreementRequest request)

Method Parameters

Field Data Type Description
requestDelRentalAgreementRequest

DelRentalAgreementRequest

Field Data Type Description
RentalAgreementIdInt64The rental agreement Id
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelRentalAgreementResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DeleteHotelVoucher

DeleteHotelVoucher is used to remove a voucher from a hotel

HotelVoucherDeleteResponse DeleteHotelVoucher(HotelVoucherDeleteRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestHotelVoucherDeleteRequest

HotelVoucherDeleteRequest

Field Data Type Description
HotelVoucherCodeStringThe hotel voucher to be deleted
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

HotelVoucherDeleteResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelAddress

DelHotelAddress is used to delete a hotel Address for a specified hotel.

DelHotelAddressResponse DelHotelAddress(DelHotelAddressRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:DelHotelAddress>        
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>            
            <ns:Username>?</ns:Username>            
            <ns:Password>?</ns:Password>            
            <roam:HotelAddressId>?</roam:HotelAddressId>            
            <roam:HotelId>?</roam:HotelId>
         </con:request>
      </con:DelHotelAddress>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestDelHotelAddressRequest

DelHotelAddressRequest

Field Data Type Description
HotelAddressIdInt64The Hotel Address Id of the Address you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelAddressResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelContact

DelHotelContact is used to delete a contact for a specified hotel.

DelHotelContactResponse DelHotelContact(DelHotelContactRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:DelHotelContact>
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <ns:Username>?</ns:Username>
            <ns:Password>?</ns:Password>
            <roam:HotelContactId>?</roam:HotelContactId>
            <roam:HotelId>?</roam:HotelId>
         </con:request>
      </con:DelHotelContact>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestDelHotelContactRequest

DelHotelContactRequest

Field Data Type Description
HotelContactIdInt64The Hotel Contact Id of the contact you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelContactResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelDescription

DelHotelDescription is used to delete a hotel Description for a specified hotel.

DelHotelDescriptionResponse DelHotelDescription(DelHotelDescriptionRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:DelHotelDescription>        
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>            
            <ns:Username>?</ns:Username>            
            <ns:Password>?</ns:Password>            
            <roam:HotelDescriptionId>?</roam:HotelDescriptionId>            
            <roam:HotelId>?</roam:HotelId>
         </con:request>
      </con:DelHotelDescription>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestDelHotelDescriptionRequest

DelHotelDescriptionRequest

Field Data Type Description
HotelDescriptionIdInt64The Hotel Description Id of the description you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelDescriptionResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelFeature

DelHotelFeature is used to delete a Feature for a specified hotel.

DelHotelFeatureResponse DelHotelFeature(DelHotelFeatureRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:DelHotelFeature>
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <ns:Username>?</ns:Username>
            <ns:Password>?</ns:Password>
            <roam:HotelFeatureId>?</roam:HotelFeatureId>
            <roam:HotelId>?</roam:HotelId>
         </con:request>
      </con:DelHotelFeature>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestDelHotelFeatureRequest

DelHotelFeatureRequest

Field Data Type Description
HotelFeaturesHotelFeaturesA List of Hotel Feature Ids which you want to remove.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelFeatures

A List of Hotel Feature Ids which you want to remove.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

TimeSpan

Field Data Type Description

DelHotelFeatureResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelImage

DelHotelImage is used to delete an image for a specified hotel.

DelHotelImageResponse DelHotelImage(DelHotelImageRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:DelHotelImage>
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <ns:Username>?</ns:Username>
            <ns:Password>?</ns:Password>
            <roam:HotelId>?</roam:HotelId>
            <roam:HotelImageId>?</roam:HotelImageId>
         </con:request>
      </con:DelHotelImage>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestDelHotelImageRequest

DelHotelImageRequest

Field Data Type Description
HotelImageIdInt64The Hotel Image Id of the Image you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelImageResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelRatePackage

DelHotelRatePackage is used to Delete a Rate Package for a hotel.

DelHotelRatePackageResponse DelHotelRatePackage(DelHotelRatePackageRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestDelHotelRatePackageRequest

DelHotelRatePackageRequest

Field Data Type Description
HotelRatePackageIdInt64The Hotel Rate Package Id of the Hotel Rate Package you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelRatePackageResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelRatePackageDeal

DelHotelRatePackageDeal is used to Delete a Rate Package Deal for a hotel.

HotelRatePackageDealDeleteResponse DelHotelRatePackageDeal(HotelRatePackageDealDeleteRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestHotelRatePackageDealDeleteRequest

HotelRatePackageDealDeleteRequest

Field Data Type Description
HotelRatePackageDealIdInt64The hotel rate package deals to be deleted
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

HotelRatePackageDealDeleteResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelRegistration

DelHotelRegistrationResponse DelHotelRegistration(DelHotelRegistrationRequest request)

Method Parameters

Field Data Type Description
requestDelHotelRegistrationRequest

DelHotelRegistrationRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelRegistrationResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelRoom

DelHotelRoom is used to Delete a Room for a hotel.

DelHotelRoomResponse DelHotelRoom(DelHotelRoomRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestDelHotelRoomRequest

DelHotelRoomRequest

Field Data Type Description
HotelRoomIdInt64The Hotel Room Id of the Hotel Room you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelRoomResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelRoomFeature

DelHotelRoomFeature is used to delete all Room Features specified in the request for a paricular room.

DelHotelRoomFeaturesResponse DelHotelRoomFeature(DelHotelRoomFeaturesRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestDelHotelRoomFeaturesRequest

DelHotelRoomFeaturesRequest

Field Data Type Description
HotelRoomFeatureIdsHotelRoomFeaturesThe Hotel Room Feature Id of the Hotel Room Feature you wish to delete.
HotelRoomIdInt64The Hotel Room Id that is the parent of the Features you want to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelRoomFeatures

The Hotel Room Feature Id of the Hotel Room Feature you wish to delete.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

TimeSpan

Field Data Type Description

DelHotelRoomFeaturesResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelType

DelHotelType is used to delete a hotel type for a specified hotel.

DelHotelTypeResponse DelHotelType(DelHotelTypeRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:DelHotelType>        
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>            
            <ns:Username>?</ns:Username>            
            <ns:Password>?</ns:Password>            
            <roam:HotelId>?</roam:HotelId>            
            <roam:HotelTypeId>?</roam:HotelTypeId>
         </con:request>
      </con:DelHotelType>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestDelHotelTypeRequest

DelHotelTypeRequest

Field Data Type Description
HotelTypeIdInt64The Hotel Type Id of the Hotel Type you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelTypeResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DelHotelUser

DelHotelUser is used to delete a hotel user for a specified hotel.

DelHotelUserResponse DelHotelUser(DelHotelUserRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:DelHotelUser>        
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>            
            <ns:Username>?</ns:Username>            
            <ns:Password>?</ns:Password>            
            <roam:HotelId>?</roam:HotelId>            
            <roam:HotelUserId>?</roam:HotelUserId>
         </con:request>
      </con:DelHotelUser>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestDelHotelUserRequest

DelHotelUserRequest

Field Data Type Description
HotelUserIdInt64The Hotel User Id of the User you wish to delete.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

DelHotelUserResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

GetBookingQuestions

GetBookingQuestions is used to list the current Booking Questions for a Hotel.

BookingQuestionsResponse GetBookingQuestions(BookingQuestionsRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestBookingQuestionsRequest

BookingQuestionsRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

BookingQuestionsResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
BookingQuestionsList of BookingQuestionThe Booking Questions List
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

BookingQuestion

The Booking Questions List

Field Data Type Description
BookingQuestionIdInt64The unique BookingQuestionId
HotelIdInt64The unique HotelId
BookingQuestionTypeBookingQuestionTypeThe BookingQuestionType for this BookingQuestion
QuestionStringThe Question of the BookingQuestion
MandatoryResponseBooleanThe Question required an answer from the guest, or not.
RatePackageIdsRatePackageIdsList is rate plans that this booking questionapplies to. If none are specified then all rate plans apply.
RoomTypeIdsRoomTypeIdsList is room types that this booking questionapplies to. If none are specified then all room types apply.
OptionsBookingQuestionOptionsThe optional values to be selected for this Booking Question

BookingQuestionType

The BookingQuestionType for this BookingQuestion

Field Data Type Description
YONYes or No
TXTText
MULMultiple Choice
ALENone (Alert Only)

RatePackageIds

List is rate plans that this booking questionapplies to. If none are specified then all rate plans apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

RoomTypeIds

List is room types that this booking questionapplies to. If none are specified then all room types apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

BookingQuestionOptions

The optional values to be selected for this Booking Question

Field Data Type Description
CapacityInt32
CountInt32
ItemString

GetClientAutoLoginUrl

ClientAutoLoginUrl GetClientAutoLoginUrl(ClientAutoLoginUrlRequest request)

Method Parameters

Field Data Type Description
requestClientAutoLoginUrlRequest

ClientAutoLoginUrlRequest

Field Data Type Description
ClientIpAddressString
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

ClientAutoLoginUrl

Field Data Type Description
UrlUriUrl the client can use to access channel manager
ExpiryTimeUtcDateTimeExpiry time UTC after which the provided uri will no longer work. Sessions authenticated with the uri will remain authenticated subject to standard session expiration
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

Uri

Url the client can use to access channel manager

Field Data Type Description

GetDcBookingFees

Load the Dc Fees for a Booking

GetDcBookingFeesResponse GetDcBookingFees(GetDcBookingFeesRequest request)

Method Parameters

Field Data Type Description
requestGetDcBookingFeesRequest

GetDcBookingFeesRequest

Field Data Type Description
BookingIdInt64
DistributionChannelString
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

GetDcBookingFeesResponse

Field Data Type Description
DcBookingFeesList of BookingFee
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

BookingFee

Field Data Type Description
DcBookingFeeIdInt64
DistributionChannelIdInt64
AmountDecimal
FeeTypeString
FeeNameString

GetHotel

GetHotel returns a hotel object for the specified HotelID.

GetHotelResponse GetHotel(GetHotelRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:GetHotel>        
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>            
            <ns:Username>?</ns:Username>            
            <ns:Password>?</ns:Password>            
            <roam:HotelID>?</roam:HotelID>
         </con:request>
      </con:GetHotel>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestGetHotelRequest

GetHotelRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

GetHotelResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelHotelThe Hotel Object
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

Hotel

The Hotel Object

Field Data Type Description
VersionInt64The Version number which is incremented automatically every time something relating to the Hotel has changed in the database
HotelIdInt64This is the unique identifier for your hotel.
When you are creating a new hotel you must set this value to 0.
When updating an already existing hotel it must be set to a valid Hotel Id for your username and password.
NameStringThe Name of the Hotel.
Minimum Length: 5 characters.
Maximum Length: 100 characters.
CountryISOStringThe Country ISO of the Country where the Hotel is located. To find a valid Country ISO call GetStaticData.
CurrencyISOStringThe Preferred Currency that the Hotel Deals in. To find a valid Currency ISO call GetStaticData.
LatitudeDecimalGeo-coordinate Latitude
LongitudeDecimalGeo-coordinate Longitude
LocalityIdInt64The Locality ID of the Suburb / Location that the hotel is closest to.
MaxAgeChildInt32The Maximum Age for a child before they will be treated as an adult in regards to calculating booking prices.
MaxAgeInfantInt32The Maximum age before a guest is considered no longer an infant.
MinBookingHoursDecimalThe Number of Hours that a booking must be made prior to checkin time before the hotel deams the booking too close to checkin, and won't allow the booking to happen for that day.
PropertyManagementSystemCODEStringThe Property Management System code for the PMS software that the hotel uses (eg, RMS, EZYREZ, HIRUM, OPERA etc...)
StarRatingDecimalThe Star Rating as given by the Rating Company
StarRatingMembNumStringThe Star Rating Membership number given to the hotel by the Rating Company.
Minimum Length: 1 character.
Maximum Length: 20 characters.
StarRatingTypeStringThe Star Rating Type Code, eg, SLF for Self Rated, AAA for AAA rated, INT for Internationally Rated, OTH for other.
BankAccountNameStringThe Name of the Hotels Bank account
BookingFormTrackingCodeStringWhen the Booking form is displayed for this ap, this script or image is inserted into the page for tracking purposes.
BankAccountNumberStringThe Bank Account number for the Hotels bank account
BankIdentifierCodeStringAn Indeitifer for the Bank Account
BankNameStringThe name of the Banking institution where the Hotels bank account is kept
BranchNameStringThe Branch for the Bank Account
BSBNumberStringThe Bank accounts Bank State Branch Number
BankAccountSuffixStringThe Bank Accounts Suffix
EmailStringAn Email Address to use when contacting the Hotel for general use.
FaxStringThe Hotels General Fax Number
ManagerStringThe Managers name for the Hotel
MaximumArrivalTimeStringThe Maximum arrival time on a day, this is stored as 4 digits, eg, 2300 is 11pm
MaximumDepartureTimeStringThe Maximum departure time on a day, this is stored as 4 digits, eg, 1200 is 12pm
MinimumArrivalTimeStringThe minimum Arrival Time on a day, this is stored as 4 digits, eg, 1030 is 10:30 am
MinimumDepartureTimeStringThe Minimum Departure Time on a day, this is stored as 4 digits, eg, 0420 is 4:20 am
NotesStringAny Notes about the Hotel, this is not displayed anywhere.
PrimaryPhoneNumberStringThe Hotels Primary Phone Number
TaxRegistrationNumberStringThe Hotels tax Number, in Australia this is known as the ABN.
TaxTypeStringThe Hotels Tax Type, eg GST = Registered for GST, INT = Input Tax Registered, N/T = Not Registered for Tax in Australia.
BookingConfirmationTextStringWhen a Booking is confirmed, display this additional text on the Booking confirmation, and Confirmation Emails.
WebsiteURLStringThe Hotels main Website URL, eg, http://www.greathotel.com.au
QtyRoomsInt64The estimated Qty of Rooms that the Hotel/Property has for sale
AddressesList of HotelAddressA List of Address Data for the Hotel
DescriptionsList of HotelDescriptionA List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc...
ImagesList of HotelImageA List of Property Images
HotelTypesList of HotelTypeA List of Hotel Types that categorize the Hotel. Normally you would only have one type attached (eg, Hotel), but the system does cater for more than 1.
For a list of valid HotelTypes you can call GetStaticData.
HotelUsersList of HotelUserA List of Users that are allowed to login to the Extranet and view / modify information relating to this Hotel.
FeaturesList of HotelFeatureA List of Features that describe what facilities or amenities the Hotel has
ContactsList of HotelContactA List of Contacts for your Hotel.
TimezoneIdentifierStringThe timezone of the Hotel
HotelRegistrationHotelRegistrationHotel Registration and Exemption Codes for properties that require them.

HotelAddress

A List of Address Data for the Hotel

Field Data Type Description
HotelAddressIDInt64A Unique Identifier to identify the Hotel Address, if you are using this object to attach a new Address to a Hotel, specify nil or 0
AddressTypeStringType of Address, Street or Postal
AddressLine1StringThe Address line with the highest Priority, it is Also Mandatory
AddressLine2String2nd Address Line if required
AddressLine3String3rd Address Line if required
AddressLine4String4th Address Line if required
SuburbStringSuburb
CityStringCity
StateStringState as a String, eg, QLD, or Queensland
PostcodeStringPostcode for the Address
CountryISOStringThe Country ID

HotelDescription

A List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc...

Field Data Type Description
HotelDescriptionIDInt64A Unique Identifer to identify the Hotel Description, if you are using this object to Attach a new Description to the Hotel, specify nil or 0
DescriptionCodeStringCode for the Description, STR = Street, POS = Postal
DescriptionNameStringName of the Description
ValueStringThe Description Value

HotelImage

A List of Property Images

Field Data Type Description
HotelImageIDInt64A Unique Identifier for this Hotel Image, if you are using this object to create a new image against the hotel, specify nil or 0
DisplaySequenceInt64Use this to display the images in the order specified by the hotel
LargeUrlStringThe URL where the Large version of the image resides.
ThumbUrlStringThe URL where the Thumbnail version of the image resides.
ToolTipTextStringWhen a mouse is hovered over the Image, display this text.
HeroImageBooleanHero Image: This image can be used as the main image on listing pages. If this element is missing, then HeroImage = false
WidthInt64Width of the large version of this image.
HeightInt64Height of the large version of this image.

HotelType

A List of Hotel Types that categorize the Hotel. Normally you would only have one type attached (eg, Hotel), but the system does cater for more than 1.
For a list of valid HotelTypes you can call GetStaticData.

Field Data Type Description
HotelTypeIDInt64A Unique Identifier for this Hotel Type, if you are using this object to attach a new HotelType to the Hotel, specify nil or 0
HotelTypeCodeStringThe Hotel Type Code, possible values are (Cabin,Chalet,Houseboat,Lodge,Villa,Cottage,Apartment,B&B,Backpacker / Hostel,Condo,Guest House,Hotel,Motel,Private Apartment,Resort,Tourist / Caravan Park,Holiday House,Holiday Park)

HotelUser

A List of Users that are allowed to login to the Extranet and view / modify information relating to this Hotel.

Field Data Type Description
HotelUserIDInt64A Unique Identifier to identify the User, if you are using this object to attach a New HotelUser to the Hotel, specify nil or 0
FirstNameStringUsers First Name
LastNameStringUsers Last Name
EmailAddressStringUsers Email Address
UsernameStringUsers Username
PasswordStringUsers Password
RoleStringRole type / or group, Eg, Administrator, Reservations, Accounts, Reception
MobileStringUsers Mobile Number

HotelFeature

A List of Features that describe what facilities or amenities the Hotel has

Field Data Type Description
HotelFeatureIDInt64A Unique Identifier to identify the Hotel Feature, if you are using this object to create a new feature, specify nil or 0
NameStringThe name of the Feature, this text is displayed on the Websites when promoting the Hotel
DisplaySequenceInt64The Display Sequence, or order that that the feature should be positioned when displaying the Feature on the Hotels Sales Page.

HotelContact

A List of Contacts for your Hotel.

Field Data Type Description
HotelContactIdInt64A Unique Identifier for this Hotel Contact, if you are using this object to create a new Contact against the hotel, specify nil or 0
TitleStringThe Title of this Hotel Contact. For Example: Mr, Mrs.
EmailAddressStringThe Hotel Contact Email Address.
FirstNameStringThe Hotel Contact First Name
PhoneNumberStringThe Hotel Contact Contact Phone Number
LastNameStringThe Hotel Contact Surname.
MobileNumberStringThe Hotel Contact Mobile Phone Number
ContactPositionStringThe position of the hotel contact in your company, General Manager, Office Manager
FaxNumberStringThe Hotel Contact Fax Number.

HotelRegistration

Hotel Registration and Exemption Codes for properties that require them.

Field Data Type Description
RegistrationNumberStringAn Optional Registration Number such as STRA Number
RegistrationDateDateTimeDate Registration was acquired
RegistrationExpiryDateTimeRegistration Expiry Date
RegistrationExemptionStringAn code making the property exempt of requiring Registration (Only required if the property resides within an area requiring Registration)
UpdateAllChannelsBooleanSet to true to push to all OTA distribution channels

GetHotelDCFees

get distribution fees for a hotel

GetHotelDCFeesResponse GetHotelDCFees(GetHotelDCFeesRequest request)

Method Parameters

Field Data Type Description
requestGetHotelDCFeesRequest

GetHotelDCFeesRequest

Field Data Type Description
DistributionChannelCodeStringThe unique code for the distribution channel.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

GetHotelDCFeesResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
FeesList of DCHotelFeeAll room ids affected are returned here. If you create a new room the ID will also be in here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

DCHotelFee

All room ids affected are returned here. If you create a new room the ID will also be in here.

Field Data Type Description
FeeIdInt64
FeeDefinitionIdInt64
HotelIdInt64
DistributionChannelIdInt64
DistributionChannelString
FeeNameString
FeeCodeString
AmountDecimal
DCHotelFeeSettingsList of DCHotelFeeSetting
RatePlansList of DCHotelFeeRatePlan

DCHotelFeeSetting

Field Data Type Description
SettingIdInt64
SettingTypeIdInt64
DistributionChannelIdInt64
DistributionChannelString
SettingNameString
GroupIdInt64
SettingCodeString
SettingTypeString
FeeIdInt64
SettingValueString
DCHotelFeeConstraintsList of DCHotelFeeConstraint

DCHotelFeeConstraint

Field Data Type Description
ConstraintIdInt64
ConstraintTypeIdInt64
DistributionChannelIdInt64
DistributionChannelString
SettingIdInt64
ConstraintNameString
ConstraintCodeString
MinDateDateTime
MaxDateDateTime
MinNumberDecimal
MaxNumberDecimal
DaysList of Int64

DCHotelFeeRatePlan

Field Data Type Description
RateFeeIdInt64
FeeIdInt64
RatePlanIdInt64

GetHotelExtras

GetHotelExtras is used to list the current extras for a Hotel.

HotelExtrasResponse GetHotelExtras(HotelExtrasRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestHotelExtrasRequest

HotelExtrasRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

HotelExtrasResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelExtrasList of HotelExtraThe Hotel Extra List
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

HotelExtra

The Hotel Extra List

Field Data Type Description
HotelExtraIdInt64The unique HotelExtraId
HotelIdInt64The unique HotelId
HotelExtraTypeHotelExtraTypeThe HotelExtraType for this HotelExtra
NameStringThe Name of the HotelExtra
DescriptionStringThe description of the HotelExtra
AmountDecimalThe amount of the HotelExtra - Not required for Per Person HotelExtraType
AdultAmountDecimalThe adult amount of the HotelExtra - Required for Per Person HotelExtraType
ChildAmountDecimalThe child amount of the HotelExtra - Required for Per Person HotelExtraType
RatePackageIdsRatePackageIdsList is rate plans that this hotel extra applies to. If none are specified then all rate plans apply.
RoomTypeIdsRoomTypeIdsList is room types that this hotel extra applies to. If none are specified then all room types apply.

HotelExtraType

The HotelExtraType for this HotelExtra

Field Data Type Description
BOOPer Booking
NGTPer Night
PERPer Person
QTYPer Quantity

RatePackageIds

List is rate plans that this hotel extra applies to. If none are specified then all rate plans apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

RoomTypeIds

List is room types that this hotel extra applies to. If none are specified then all room types apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

GetHotelRatePackageDeals

GetHotelRatePackageDeals returns the hotel rate package deal objects for the specified hotel room

HotelRatePackageDealsResponse GetHotelRatePackageDeals(HotelRatePackageDealsRequest request)

Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:GetHotelRatePackageDeals>
         <!--Optional:-->
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <!--Optional:-->
            <ns:Username>?</ns:Username>
            <!--Optional:-->
            <ns:Password>?</ns:Password>
            <!--Optional:-->
            <roam:HotelID>184424</roam:HotelID>
            <!--Optional:-->
            <roam:HotelRatePackageID>38447</roam:HotelRatePackageID>
         </con:request>
      </con:GetHotelRatePackageDeals>
   </soapenv:Body>
</soapenv:Envelope>
            

Method Parameters

Field Data Type Description
requestHotelRatePackageDealsRequest

HotelRatePackageDealsRequest

Field Data Type Description
HotelRatePackageIDInt64The HotelRatePackageID for the HotelRatePackageDeals to be returned.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

HotelRatePackageDealsResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelDealsList of HotelRatePackageDealThe Hotel Room Object
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

HotelRatePackageDeal

The Hotel Room Object

Field Data Type Description
HotelRatePackageDealIdInt64The unique HotelRatePackageDealId
HotelRatePackageIdInt64The unique HotelRatePackageId
HotelRatePackageNameStringThe Name of the HotelRatePackage
DescriptionStringThe description of the deal eg. (Stay 7 nights pay 5 nights)
ShortDescriptionStringThe description of the deal eg. (Stay 7 nights pay 5 nights)
StartDateDateTimeStarting Date for the deal
EndDateDateTimeEnd Date for the deal
BookableStartDateDateTimeFirst date upon which the deal may be booked
BookableEndDateDateTimeLast date upon which the deal may be booked
HotelRatePackageDealTypeHotelRatePackageDealTypeThe type of the deal
StayNightsInt64The number of nights that can be stayed
PayNightsInt64The number of nights that must be paid for
RepeatableBooleanIs this deal repeatable?
DiscountDecimalDiscount off the standard rate
CloseOutInt64Maximum number of days before check in this deal is available for
CloseOutTypeStringHow the Closeout field should be handled, BEF = Before Arrival, AFT = after arrival.
DatesRangesExcludedList of DateRangeList of dates that deal does not apply to
DaysOfWeekExcludedList of DayOfWeekDays of the week that this deal does not apply to
PackageNightsInt64The number of nights the package rate applies for
PackageRateDecimalThe alternate rate for the package
PackageRateContinuesBooleanDoes the rate for this package continue past the number of package days. Otherwise it falls back to the standard rate
SearchRatePackageIdInt64Use this ID to attach to the RoomId field in the booking form. This id is the same id that the booking form uses to book this Special. This field is a read only field. On save messages, leave this field out or set it to null
ValidForHotelVoucherOnlyBooleanIs this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher?
NoVoucherDiscountAppliesBooleanIs this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher?
DCMappingsList of SpecialDCMappingYou can map a special to a channel and market it as a special which should be sent to them. If you want to remove a mapping which is already in the system, simply do not supply it in this list and it will be removed.

HotelRatePackageDealType

The type of the deal

Field Data Type Description
SPYStay Pay
DISPercentage Discount
DIVValue Discount
PKGPackage Deal

DateRange

List of dates that deal does not apply to

Field Data Type Description
FromDateTime
ToDateTime

DayOfWeek

Days of the week that this deal does not apply to

Field Data Type Description

SpecialDCMapping

You can map a special to a channel and market it as a special which should be sent to them. If you want to remove a mapping which is already in the system, simply do not supply it in this list and it will be removed.

Field Data Type Description
DCCodeStringThe Distribution Channel code the mapping is for. You can get a list of possible distribution channels using the GetStaticData message.
SourceSpecialIdStringThis is the distribution channels unique identifier for the special which is created. Set this to an Empty string when you are creating a new mapping. Also, this field is read only, so setting it to a value will not make any changes
SettingsList of SpecialDCSettingEach channel can have custom parameters which they want to be sent to them when saving a Mapping. To get this list of possibilities, please contact our support team as the list is different for each channel and we have no API call that you can use to get them yet.

SpecialDCSetting

Each channel can have custom parameters which they want to be sent to them when saving a Mapping. To get this list of possibilities, please contact our support team as the list is different for each channel and we have no API call that you can use to get them yet.

Field Data Type Description
KeyStringThe Unique key code for the setting.
ValueStringThe Value specified. Any dates must be saved in the format yyyy-MM-dd HH24:mi:ss. Any booleans must be true or false.

GetHotelRentalAgreement

Get Rental Agreement for a hotel

GetRentalAgreementResponse GetHotelRentalAgreement(GetRentalAgreementRequest request)

Method Parameters

Field Data Type Description
requestGetRentalAgreementRequest

GetRentalAgreementRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

GetRentalAgreementResponse

Field Data Type Description
HotelIdInt64
AgreementIdInt64
FileNameString
FileUrlString
DateModifiedDateTime
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

GetHotelRooms

GetHotelRooms is used to gather all the hotel rooms and room features for a specified hotel.

GetHotelRoomsResponse GetHotelRooms(GetHotelRoomsRequest request)

Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:GetHotelRooms>
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <ns:Username>?</ns:Username>
            <ns:Password>?</ns:Password>
            <roam:HotelID>?</roam:HotelID>
         </con:request>
      </con:GetHotelRooms>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestGetHotelRoomsRequest

GetHotelRoomsRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

GetHotelRoomsResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelRoomsList of HotelRoomThe Hotel Room Object
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

HotelRoom

The Hotel Room Object

Field Data Type Description
VersionInt64
HotelRoomIdInt64The unique HotelRoomId
HotelIdInt64The unique HotelID
NameStringThe name of the Hotel Room.
DescriptionStringThe description of the hotel room.
BedConfigurationStringThe Bedding Configuration for the hotel room.
LowAvailabilityQtyInt64The Low availability hotel room quantity.
QtyPhysicalBedroomsInt64The Qty of Bedrooms in this Room.
QtyBathroomsInt64The Qty of Bathrooms, please don't include Ensuites in this qty.
QtyEnsuitesInt64The Qty of Ensuites. Please don't include ensuites in the QtyBathrooms field.
RoomTypeFeaturesList of HotelRoomFeatureA List of Hotel Room Features. The Hotel Room Features Available for your Hotel type can be found by querying static data.
RatePackagesList of HotelRatePackageA List of Rate Packages or "Ways to sell this Room".
AutoFillOptionsRoomAutoFillOptionsWe use the same HotelRoom object for Both Save and Read, so when creating a new Room, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests
ImagesImageIdentifiersThe image identifiers attached to this room. The ids can be obtained from the GetHotelDetail message
RoomHeroImageIdInt64The image id that the property wishes to be displayed as the hero image. This id references to the image ids that are returned from the the GetHotel message.
BedroomsList of HotelRoomBedroomThe Bedrooms in this room and the bedding configurations of each.
BathroomsList of HotelRoomBathroomThe Bathrooms in this room and the features present in each.
PMSRoomCodeStringThe unique ID for the PMS system which is creating this room. This field is useful to map between Resonline's IDs and your unique Id.
UnitAreaInt64The area of the room that is available to guests.
UnitAreaTypeStringThe measurement type for the area of the room. Either SQM - Square Meters or SQF - Square Feet.

HotelRoomFeature

A List of Hotel Room Features. The Hotel Room Features Available for your Hotel type can be found by querying static data.

Field Data Type Description
HotelRoomFeatureIdInt64The unique HotelRoomFeatureId
FeatureTypeIdInt64The unique FeatureTypeId
FeatureTypeNameStringThe unique FeatureTypeName
DisplaySeqInt64The display position for the Hotel Room Feature.

HotelRatePackage

A List of Rate Packages or "Ways to sell this Room".

Field Data Type Description
VersionInt64
HotelRatePackageIdInt64The unique HotelRatePackageId
HotelIdInt64The unique id for the Hotel that this RatePackage is connected to
NameStringThe name of the Hotel Rate Package.
DescriptionStringThe description of the hotel Rate Package.
StandardGuestsInt64The number of guests that the price caters for, once you have more guests, there maybe extra charges which are the Extra*Charges fields.
MaximumGuestsAllowedInt64The maximum number of guests that can be included in this Rate Package. We don't count infants.
ExtraAdultChargeDecimalThe Charge to be applied for every adult guest that is above the StandardGuests value.
ExtraChildChargeDecimalThe Charge to be applied for every child guest that is above the StandardGuests value.
RackRateDecimalRack rate or Standard Rate for this Rate Package.
AutoFillOptionsRateAutoFillOptionsWe use the same HotelRatePackage object for Both Save and Read, so when creating a new RatePackage, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests
LmDefaultsDefaultRateGeneratorAn Object which specifies the Last Minute Defaults to be applied when rolling over new Dates.
YrDefaultsDefaultRateGeneratorAn Object which specifies the Year Round Defaults to be applied when rolling over new Dates.
ImagesImageIdentifiersThe image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message
OpenForSaleFromInt32You can use OpenForSaleFrom and OpenForSaleTo to set restrictions for this rate package on when it can be purchased. Eg, if you have OpenForSaleFrom = 0, and OpenForSaleTo = 90, then bookings can be made in the next 90 days, but afterwards the rate package will no longer be available for sale. Set to Null for no restriction.
OpenForSaleToInt32You can use OpenForSaleFrom and OpenForSaleTo to set restrictions for this rate package on when it can be purchased. Eg, if you have OpenForSaleFrom = 0, and OpenForSaleTo = 90, then bookings can be made in the next 90 days, but afterwards the rate package will no longer be available for sale. Set to Null for no restriction.
RatePlanHeroImageIdInt64The image id that the property wishes to be displayed as the hero image. This id references to the image ids that are returned from the the GetHotel message.
RateOwnerStringThe system that 'owns' the rate. Used to determine which rates can be managed by automated processes
PMSCodeStringA unique identifier which identifies the Property Management systems code for their rate plan equivilent. Useful to determine if a rate plan in your system is already created in our system.
DerivedRatePackagesList of DerivedRatePackageRule for calculating derived rates for this rate package

RateAutoFillOptions

We use the same HotelRatePackage object for Both Save and Read, so when creating a new RatePackage, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests

Field Data Type Description
RateDecimalSet the default Price for this RatePackage for the next 2 years to the value specified.
MinimumNightStayInt32Set the Minimum nights that a guest must stay to qualify for this Rate for the next 2 years to the value specified.
InclusionsStringSet the Inclusion text for each default Rates for the next 2 years to the value specified.

DefaultRateGenerator

An Object which specifies the Last Minute Defaults to be applied when rolling over new Dates.

Field Data Type Description
RatesDayRateGridList of Prices which represents the day of the week, starting at Monday
MinNightsDayMinNightsGridList of Minimum Nights which represents the day of the week, starting at Monday
DefaultInclusionStringOne Inclusion String to be applied to all days when applying defaults.
NumberOfDaysOutInt32The Number of Days from the rollover date for the defaults to be applied.
OverwriteExistingRatesBooleanSet this to True if you want the Default rates to overwrite the existing rates that are stored in the database for this RatePackage. This Object is a shared object, so this field is only used when setting, the value returned when retrieving values is irelevant.

DayRateGrid

List of Prices which represents the day of the week, starting at Monday

Field Data Type Description
MondayDecimal
TuesdayDecimal
WednesdayDecimal
ThursdayDecimal
FridayDecimal
SaturdayDecimal
SundayDecimal
CountInt32

DayMinNightsGrid

List of Minimum Nights which represents the day of the week, starting at Monday

Field Data Type Description
MondayInt32
TuesdayInt32
WednesdayInt32
ThursdayInt32
FridayInt32
SaturdayInt32
SundayInt32
CountInt32

DefaultRateGenerator

An Object which specifies the Year Round Defaults to be applied when rolling over new Dates.

Field Data Type Description
RatesDayRateGridList of Prices which represents the day of the week, starting at Monday
MinNightsDayMinNightsGridList of Minimum Nights which represents the day of the week, starting at Monday
DefaultInclusionStringOne Inclusion String to be applied to all days when applying defaults.
NumberOfDaysOutInt32The Number of Days from the rollover date for the defaults to be applied.
OverwriteExistingRatesBooleanSet this to True if you want the Default rates to overwrite the existing rates that are stored in the database for this RatePackage. This Object is a shared object, so this field is only used when setting, the value returned when retrieving values is irelevant.

DayRateGrid

List of Prices which represents the day of the week, starting at Monday

Field Data Type Description
MondayDecimal
TuesdayDecimal
WednesdayDecimal
ThursdayDecimal
FridayDecimal
SaturdayDecimal
SundayDecimal
CountInt32

DayMinNightsGrid

List of Minimum Nights which represents the day of the week, starting at Monday

Field Data Type Description
MondayInt32
TuesdayInt32
WednesdayInt32
ThursdayInt32
FridayInt32
SaturdayInt32
SundayInt32
CountInt32

ImageIdentifiers

The image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

DerivedRatePackage

Rule for calculating derived rates for this rate package

Field Data Type Description
ParentRatePackageIdInt64RatePackageId that the rate is derived from
DaysFromInt32Days from today to start applying this rule
DaysUntilInt32Days after today to apply this rule
RatePlanDerivationTypeRatePlanDerivationTypeType of rate derivation
DerivedValueDecimalValue used in the derivation calculation
RoundingRoundingHow to round the result

RatePlanDerivationType

Type of rate derivation

Field Data Type Description
PERPercentage
VALValue
MANManually Set

Rounding

How to round the result

Field Data Type Description
UPRound Up
DOWNRound Down
NEARRound to the closest whole
NONENo rounding

RoomAutoFillOptions

We use the same HotelRoom object for Both Save and Read, so when creating a new Room, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests

Field Data Type Description
QtyRoomsAvailableInt32Set the Qty of Rooms Available for this Room for the next 2 years to the value specified.

ImageIdentifiers

The image identifiers attached to this room. The ids can be obtained from the GetHotelDetail message

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

HotelRoomBedroom

The Bedrooms in this room and the bedding configurations of each.

Field Data Type Description
BedroomIdInt64The unique BedroomId, set this to zero for new bedrooms
BedroomNoInt64The ordering of bedrooms, e.g 1,2
BedroomNameStringThe name of the Bedroom e.g Master Bedroom
EnsuiteBooleanWhether the Bedroom has an en suite
BedroomTypeStringThe name of the bedroom type for display purposes only
RoomTypeIdInt64The unique room id this bedroom belongs to
BeddingConfigurationsList of HotelRoomBeddingConfigThe list of bedding configurations this bedroom can have
BedroomTypeCodeStringThe bedroom type code

HotelRoomBeddingConfig

The list of bedding configurations this bedroom can have

Field Data Type Description
BeddingConfigIdInt64The unique bedding config id, set to zero for new configs
BedroomIdInt64The unique bedroom id this config belongs to
DefaultConfigBooleanSet to true to mark this config as the default config or setup for this room
BedsList of HotelRoomBedsThe list of beds within this configuration

HotelRoomBeds

The list of beds within this configuration

Field Data Type Description
BedTypeStringThe bed type code
NameStringThe name of the bed type, for display purposes
AmountInt64The amount of beds supplied for this config/room

HotelRoomBathroom

The Bathrooms in this room and the features present in each.

Field Data Type Description
BathroomIdInt64The unique bathroom id for this bathroom, set to zero for new bathrooms
RoomTypeIdInt64The unique room id that this bathroom belongs to
BathroomTypeIdInt64The internal id of the bathroom type
BathroomNumberInt64The ordering of the bathrooms.
BathroomTypeStringThe bathroom type code
BathroomFeaturesList of HotelRoomBathroomFeatureThe list of amenities within this bathroom

HotelRoomBathroomFeature

The list of amenities within this bathroom

Field Data Type Description
BathroomFeatureIdInt64The internal id of this bathroom feature type
BathroomFeatureCodeStringThe code of this bathroom feature type
BathroomFeatureNameStringThe name of this bathroom feature type
BathroomIdInt64The unique bathroom id that this feature belongs to
AmountInt64The amount of this feature within this bathroom

GetHotelVouchers

GetHotelVouchers is used to list the current vouchers for a Hotel

HotelVouchersResponse GetHotelVouchers(HotelVouchersRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestHotelVouchersRequest

HotelVouchersRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

HotelVouchersResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelVouchersList of HotelVoucherThe Hotel Voucher List
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

HotelVoucher

The Hotel Voucher List

Field Data Type Description
HotelIdInt64The unique HotelId
CodeStringThe unique code
DescriptionStringDescription
TypeHotelVoucherTypeThe type of hotel voucher
AmountDecimalThe type of hotel voucher
ActiveBooleanActive
AppliesToAllRatePackagesBooleanApplies to all rate packages
AppliesToAllRatePackageDealsBooleanAll Rate Package Deals can be unlocked using this voucher
RatePackagesRatePackageIdsList of Rate Package Identifiers that will have the voucher applied to them
RatePackageDealsRatePackageDealIdsList of Rate Package Deal Identifiers that will have the voucher applied to them
PaymentNotRequiredBooleanPayment is not required at booking time when using this voucher
CurrentCodeStringThe current code of the voucher needs to be specified if the voucher code is required to be changed

HotelVoucherType

The type of hotel voucher

Field Data Type Description
PerPercentage Discount
ValValue Reduction

RatePackageIds

List of Rate Package Identifiers that will have the voucher applied to them

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

RatePackageDealIds

List of Rate Package Deal Identifiers that will have the voucher applied to them

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

GetMappedChannels

get mapped distribution channels for a hotel

GetMappedChannelsResponse GetMappedChannels(GetMappedChannelsRequest request)

Method Parameters

Field Data Type Description
requestGetMappedChannelsRequest

GetMappedChannelsRequest

Field Data Type Description
IncludeArchivedBooleanIncludes archived channels in response when set to true.
IncludeMappedRatesBooleanFlag to include mapped rate plans for each channel in the response
DistributionChannelCodeStringReturn only the mappings for this distribution channel code
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

GetMappedChannelsResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelIdInt64Hotel Id
MappedDistributionChannelsList of MappedDistributionChannelList of all mapped channels for this hotel
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

MappedDistributionChannel

List of all mapped channels for this hotel

Field Data Type Description
DistributionChannelIdInt64The Distribution Channel Id
ChannelNameStringThe Distribution Channel Name
ChannelCodeStringThe Distribution Channel Code
ConnectionStatusStringThe Distribution Channel connection status
MappingIdInt64A Unique identifier for this mapping
MaxAvailToPushInt64When we send updates to channels, we don't always send all availability to the channel. This reduces the number of updates that we have to send while there are lots of rooms still available.
PropertyCodeStringThe OTAs or Distribution Channel unique property code
PropertyNameStringThe Property Name on the OTA or Distribution Channel
DCRatePlansList of DCRatePlanA List of Rate plans and their mapping status.

DCRatePlan

A List of Rate plans and their mapping status.

Field Data Type Description
DCRatePlanIdInt64The Unique Mapping ID
MappingStatusStringStatus, Active or Inactive
MinStayInt64If this mapping has a minimum stay setting. This is used to help us connect to some external OTAs where they have a room type, but different minimum nights to sell.
RateAdjustmentPercentageDecimalThis is set to adjust the prices sent to the OTA by this Percentage amount. No adjustment is sent if its null.
RatePlanIdInt64The Actual Rate Plan ID which is setup in the GetHotelRooms message
RemotePlanCodeStringThe OTA or Distribution Channels Rate Plan Code. Sometimes this is a combination of RoomTypeID with a | or ; separator, followed by the OTAs rate plan code or id.
RemotePlanNameStringThe OTA or Distribution Channels Rate Plan Name. This isn't always populated, but for some older channels this was required to identify the rate plan when sending updates. All modern channels use the RatePlanCode
APItemIdInt64If you want to use our AffiliateAPI to make quotes and make bookings, you would use this ID for the requests.

GetStaticData

GetStaticData returns a StaticData object. This object contains lists of Static data which you can use.

GetStaticDataResponse GetStaticData(GetStaticDataRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/">
   <soapenv:Header/>
   <soapenv:Body>
      <con:GetStaticData>
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <ns:Username>?</ns:Username>
            <ns:Password>?</ns:Password>
         </con:request>
      </con:GetStaticData>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestGetStaticDataRequest

GetStaticDataRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

GetStaticDataResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
StaticDataStaticDataThe Static Data Object
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

StaticData

The Static Data Object

Field Data Type Description
CountriesList of CountryThe List of Countries
CurrenciesList of CurrencyThe List of Currencies
HotelTypesList of AccomTypeThe List of Hotel Types
StarRatingProvidersList of CommonDefinitionThe List of Star Rating Providers
ContactPersonTitlesList of CommonDefinitionThe List of Valid Titles for a Contact Person
ContactPositionsList of CommonDefinitionThe List of Valid Positions for a Contact Person
PropertyManagementSystemsList of PropertyManagementSystemList of Property Management Systems
HotelTypeFeaturesList of AccomTypeFeatureList of Hotel Type Features.
HotelTypeRoomFeaturesList of AccomTypeRoomFeatureList of Hotel Type Room Features.
HotelDescriptionsList of CommonDefinitionA list of valid Hotel Descriptions.
DistributionChannelsList of DistributionChannelA list of valid Distribution Channels.
TimezonesList of TimezoneA list of valid Timezones.
DCCancellationPoliciesList of DistributionCancellationPolicyA list of Distribution Channel Cancelation Policies
DcFeeDefinitionsList of DistributionFeeDefinitionA list of Distribution Channel Fees
BedroomTypesList of BedroomTypeA list of Bedroom Types
BedTypesList of BedTypeA list of Bed Types
BathroomTypesList of BathroomTypeA list of Bathroom Types
BathroomFeaturesList of BathroomFeatureA list of Bathroom Features

Country

The List of Countries

Field Data Type Description
CountryIDInt64
CountryISOString
CountryISO2String
CountryNameString

Currency

The List of Currencies

Field Data Type Description
CurrencyIDInt64
CurrencyISOString
CurrencyNameString
CurrencySymbolString
CurrencyAbbrString
HtmlCodeString
NumDecimalsInt32
PaymentAcceptedFlagBoolean
DisplayFormatString

AccomType

The List of Hotel Types

Field Data Type Description
AccomTypeIDInt64
AccomTypeCodeString
AccomTypeNameString

CommonDefinition

The List of Star Rating Providers

Field Data Type Description
CodeStringA Unique Identifier code for this Common Definition
NameStringThe Name or Description of the Common Definition

CommonDefinition

The List of Valid Titles for a Contact Person

Field Data Type Description
CodeStringA Unique Identifier code for this Common Definition
NameStringThe Name or Description of the Common Definition

CommonDefinition

The List of Valid Positions for a Contact Person

Field Data Type Description
CodeStringA Unique Identifier code for this Common Definition
NameStringThe Name or Description of the Common Definition

PropertyManagementSystem

List of Property Management Systems

Field Data Type Description
PMSIdInt64
NameString

AccomTypeFeature

List of Hotel Type Features.

Field Data Type Description
AccomTypeCodeString
FeatureTypeIdInt64
FeatureTypeNameString

AccomTypeRoomFeature

List of Hotel Type Room Features.

Field Data Type Description
AccomTypeCodeString
FeatureTypeIdInt64
FeatureTypeNameString

CommonDefinition

A list of valid Hotel Descriptions.

Field Data Type Description
CodeStringA Unique Identifier code for this Common Definition
NameStringThe Name or Description of the Common Definition

DistributionChannel

A list of valid Distribution Channels.

Field Data Type Description
IDInt64
UniqueCodeString
NameString

Timezone

A list of valid Timezones.

Field Data Type Description
IdentifierStringIdentifying string for a timezone
NameStringFriendly name for a timezome
UtcOffsetDecimalBase offset from UTC (May be modified by DST)

DistributionCancellationPolicy

A list of Distribution Channel Cancelation Policies

Field Data Type Description
CancellationPolicyIdInt64
DistributionChannelIdInt64
DistributionChannelString
PolicyCodeString
PolicyTitleString
PolicyDescriptionString

DistributionFeeDefinition

A list of Distribution Channel Fees

Field Data Type Description
FeeTypeIdInt64
DistributionChannelIdInt64
DistributionChannelString
FeeNameString
FeeDescriptionString
FeeCodeString
DistributionFeeSettingsList of DistributionFeeSetting

DistributionFeeSetting

Field Data Type Description
SettingTypeIdInt64
FeeTypeIdInt64
SettingNameString
SettingTypeString
SettingCodeString
GroupIdInt64
DistributionFeeConstraintsList of DistributionFeeConstraint

DistributionFeeConstraint

Field Data Type Description
ConstraintTypeIdInt64
SettingTypeIdInt64
ConstraintNameString
ConstraintCodeString
ConstraintLimitInt64

BedroomType

A list of Bedroom Types

Field Data Type Description
BedroomTypeIdInt64
NameString
CodeString

BedType

A list of Bed Types

Field Data Type Description
BedTypeIdInt64
NameString
CodeString

BathroomType

A list of Bathroom Types

Field Data Type Description
BathroomTypeIdInt64
BathroomTypeNameString
BathroomTypeCodeString

BathroomFeature

A list of Bathroom Features

Field Data Type Description
BathroomFeatureTypeIdInt64
BathroomFeatureNameString
BathroomFeatureCodeString

RegisterForNotifications

RegisterForNotificationResponse RegisterForNotifications(RegisterForNotificationRequest request)

Method Parameters

Field Data Type Description
requestRegisterForNotificationRequest

RegisterForNotificationRequest

Field Data Type Description
RegisterBooleanSet to true to register for notifications or false to deregister for notifications
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

RegisterForNotificationResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

ResetHotelCache

ResetHotelCache to clear any cache objects that we have stored, so that the next call will be a live copy from our database. It should be rare that you would need to call this message, as we already invalidate the cached objects when required in our internal systems.

ResetHotelCacheResponse ResetHotelCache(ResetHotelCacheRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:ResetHotelCache>        
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>            
            <ns:Username>?</ns:Username>            
            <ns:Password>?</ns:Password>            
            <roam:HotelId>?</roam:HotelId>            
         </con:request>
      </con:ResetHotelCache>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestResetHotelCacheRequest

ResetHotelCacheRequest

Field Data Type Description
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

ResetHotelCacheResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

SaveBookingQuestion

SaveBookingQuestion is used to Save a Booking Question for a Hotel.

SaveBookingQuestionResponse SaveBookingQuestion(SaveBookingQuestionRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestSaveBookingQuestionRequest

SaveBookingQuestionRequest

Field Data Type Description
BookingQuestionsList of BookingQuestionThe Booking Questions to be saved
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

BookingQuestion

The Booking Questions to be saved

Field Data Type Description
BookingQuestionIdInt64The unique BookingQuestionId
HotelIdInt64The unique HotelId
BookingQuestionTypeBookingQuestionTypeThe BookingQuestionType for this BookingQuestion
QuestionStringThe Question of the BookingQuestion
MandatoryResponseBooleanThe Question required an answer from the guest, or not.
RatePackageIdsRatePackageIdsList is rate plans that this booking questionapplies to. If none are specified then all rate plans apply.
RoomTypeIdsRoomTypeIdsList is room types that this booking questionapplies to. If none are specified then all room types apply.
OptionsBookingQuestionOptionsThe optional values to be selected for this Booking Question

BookingQuestionType

The BookingQuestionType for this BookingQuestion

Field Data Type Description
YONYes or No
TXTText
MULMultiple Choice
ALENone (Alert Only)

RatePackageIds

List is rate plans that this booking questionapplies to. If none are specified then all rate plans apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

RoomTypeIds

List is room types that this booking questionapplies to. If none are specified then all room types apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

BookingQuestionOptions

The optional values to be selected for this Booking Question

Field Data Type Description
CapacityInt32
CountInt32
ItemString

TimeSpan

Field Data Type Description

SaveBookingQuestionResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
BookingQuestionsBookingQuestionsA List of BookingQuestions that were saved / created.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

BookingQuestions

A List of BookingQuestions that were saved / created.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

SaveDcBookingFees

Save Dc Fees for a Booking

SaveDcBookingFeesResponse SaveDcBookingFees(SaveDcBookingFeesRequest request)

Method Parameters

Field Data Type Description
requestSaveDcBookingFeesRequest

SaveDcBookingFeesRequest

Field Data Type Description
DcBookingFeesList of DcBookingFee
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

DcBookingFee

Field Data Type Description
BookingIdInt64
DistributionChannelIdInt64
AmountDecimal
FeeTypeString
FeeNameString

TimeSpan

Field Data Type Description

SaveDcBookingFeesResponse

Field Data Type Description
SuccessBoolean
MessageString
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

SaveHotel

SaveHotel is used to either Create a new Hotel or update an existing hotel.
Specifying a 0 in the HotelID field will create a new hotel.
If you wish to perform an update specify the ID of the hotel in the HotelID field Instead. Only the values specified in the Hotel Object will be updated.

SaveHotelResponse SaveHotel(SaveHotelRequest request)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model">
   <soapenv:Header/>
   <soapenv:Body>
      <con:SaveHotel>
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <ns:Username>?</ns:Username>
            <ns:Password>?</ns:Password>
            <roam:Hotel>
               <roam:Addresses>
                  <!--Zero or more repetitions:-->
                  <roam:HotelAddress>
                     <roam:AddressLine1>?</roam:AddressLine1>
                     <roam:AddressLine2>?</roam:AddressLine2>
                     <roam:AddressLine3>?</roam:AddressLine3>
                     <roam:AddressLine4>?</roam:AddressLine4>
                     <roam:AddressType>?</roam:AddressType>
                     <roam:City>?</roam:City>
                     <roam:CountryISO>?</roam:CountryISO>
                     <roam:HotelAddressID>?</roam:HotelAddressID>
                     <roam:Postcode>?</roam:Postcode>
                     <roam:State>?</roam:State>
                     <roam:Suburb>?</roam:Suburb>
                  </roam:HotelAddress>
               </roam:Addresses>
               <roam:BSBNumber>?</roam:BSBNumber>
               <roam:BankAccountName>?</roam:BankAccountName>
               <roam:BankAccountNumber>?</roam:BankAccountNumber>
               <roam:BankAccountSuffix>?</roam:BankAccountSuffix>
               <roam:BankIdentifierCode>?</roam:BankIdentifierCode>
               <roam:BankName>?</roam:BankName>
               <roam:BookingConfirmationText>?</roam:BookingConfirmationText>
               <roam:BookingFormTrackingCode>?</roam:BookingFormTrackingCode>
               <roam:BranchName>?</roam:BranchName>
               <roam:Contacts>
                  <!--Zero or more repetitions:-->
                  <roam:HotelContact>
                     <roam:ContactPosition>?</roam:ContactPosition>
                     <roam:EmailAddress>?</roam:EmailAddress>
                     <roam:FaxNumber>?</roam:FaxNumber>
                     <roam:FirstName>?</roam:FirstName>
                     <roam:HotelContactId>?</roam:HotelContactId>
                     <roam:LastName>?</roam:LastName>
                     <roam:MobileNumber>?</roam:MobileNumber>
                     <roam:PhoneNumber>?</roam:PhoneNumber>
                     <roam:Title>?</roam:Title>
                  </roam:HotelContact>
               </roam:Contacts>
               <roam:CountryISO>?</roam:CountryISO>
               <roam:CurrencyISO>?</roam:CurrencyISO>
               <roam:Descriptions>
                  <!--Zero or more repetitions:-->
                  <roam:HotelDescription>
                     <roam:DescriptionCode>?</roam:DescriptionCode>
                     <roam:DescriptionName>?</roam:DescriptionName>
                     <roam:HotelDescriptionID>?</roam:HotelDescriptionID>
                     <roam:Value>?</roam:Value>
                  </roam:HotelDescription>
               </roam:Descriptions>
               <roam:Email>?</roam:Email>
               <roam:Fax>?</roam:Fax>
               <roam:Features>
                  <!--Zero or more repetitions:-->
                  <roam:HotelFeature>
                     <roam:DisplaySequence>?</roam:DisplaySequence>
                     <roam:HotelFeatureID>?</roam:HotelFeatureID>
                     <roam:Name>?</roam:Name>
                  </roam:HotelFeature>
               </roam:Features>
               <roam:HotelID>?</roam:HotelID>
               <roam:HotelTypes>
                  <!--Zero or more repetitions:-->
                  <roam:HotelType>
                     <roam:HotelTypeCode>?</roam:HotelTypeCode>
                     <roam:HotelTypeID>?</roam:HotelTypeID>
                  </roam:HotelType>
               </roam:HotelTypes>
               <roam:HotelUsers>
                  <!--Zero or more repetitions:-->
                  <roam:HotelUser>
                     <roam:EmailAddress>?</roam:EmailAddress>
                     <roam:FirstName>?</roam:FirstName>
                     <roam:HotelUserID>?</roam:HotelUserID>
                     <roam:LastName>?</roam:LastName>
                     <roam:Password>?</roam:Password>
                     <roam:Role>?</roam:Role>
                     <roam:Username>?</roam:Username>
                  </roam:HotelUser>
               </roam:HotelUsers>
               <roam:Images>
                  <!--Zero or more repetitions:-->
                  <roam:HotelImage>
                     <roam:DisplaySequence>?</roam:DisplaySequence>
                     <roam:HotelImageID>?</roam:HotelImageID>
                     <roam:LargeUrl>?</roam:LargeUrl>
                     <roam:ThumbUrl>?</roam:ThumbUrl>
                     <roam:ToolTipText>?</roam:ToolTipText>
                  </roam:HotelImage>
               </roam:Images>
               <roam:Latitude>?</roam:Latitude>
               <roam:LocalityId>?</roam:LocalityId>
               <roam:Longitude>?</roam:Longitude>
               <roam:Manager>?</roam:Manager>
               <roam:MaxAgeChild>?</roam:MaxAgeChild>
               <roam:MaxAgeInfant>?</roam:MaxAgeInfant>
               <roam:MaximumArrivalTime>?</roam:MaximumArrivalTime>
               <roam:MaximumDepartureTime>?</roam:MaximumDepartureTime>
               <roam:MinBookingHours>?</roam:MinBookingHours>
               <roam:MinimumArrivalTime>?</roam:MinimumArrivalTime>
               <roam:MinimumDepartureTime>?</roam:MinimumDepartureTime>
               <roam:Name>?</roam:Name>
               <roam:Notes>?</roam:Notes>
               <roam:PrimaryPhoneNumber>?</roam:PrimaryPhoneNumber>
               <roam:PropertyManagementSystemCODE>?</roam:PropertyManagementSystemCODE>
               <roam:StarRating>?</roam:StarRating>
               <roam:StarRatingMembNum>?</roam:StarRatingMembNum>
               <roam:StarRatingType>?</roam:StarRatingType>
               <roam:TaxRegistrationNumber>?</roam:TaxRegistrationNumber>
               <roam:TaxType>?</roam:TaxType>
               <roam:WebsiteURL>?</roam:WebsiteURL>
               <roam:QtyRooms>?</roam:QtyRooms>
            </roam:Hotel>
         </con:request>
      </con:SaveHotel>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestSaveHotelRequest

SaveHotelRequest

Field Data Type Description
HotelHotelThe Hotel Object
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

Hotel

The Hotel Object

Field Data Type Description
VersionInt64The Version number which is incremented automatically every time something relating to the Hotel has changed in the database
HotelIdInt64This is the unique identifier for your hotel.
When you are creating a new hotel you must set this value to 0.
When updating an already existing hotel it must be set to a valid Hotel Id for your username and password.
NameStringThe Name of the Hotel.
Minimum Length: 5 characters.
Maximum Length: 100 characters.
CountryISOStringThe Country ISO of the Country where the Hotel is located. To find a valid Country ISO call GetStaticData.
CurrencyISOStringThe Preferred Currency that the Hotel Deals in. To find a valid Currency ISO call GetStaticData.
LatitudeDecimalGeo-coordinate Latitude
LongitudeDecimalGeo-coordinate Longitude
LocalityIdInt64The Locality ID of the Suburb / Location that the hotel is closest to.
MaxAgeChildInt32The Maximum Age for a child before they will be treated as an adult in regards to calculating booking prices.
MaxAgeInfantInt32The Maximum age before a guest is considered no longer an infant.
MinBookingHoursDecimalThe Number of Hours that a booking must be made prior to checkin time before the hotel deams the booking too close to checkin, and won't allow the booking to happen for that day.
PropertyManagementSystemCODEStringThe Property Management System code for the PMS software that the hotel uses (eg, RMS, EZYREZ, HIRUM, OPERA etc...)
StarRatingDecimalThe Star Rating as given by the Rating Company
StarRatingMembNumStringThe Star Rating Membership number given to the hotel by the Rating Company.
Minimum Length: 1 character.
Maximum Length: 20 characters.
StarRatingTypeStringThe Star Rating Type Code, eg, SLF for Self Rated, AAA for AAA rated, INT for Internationally Rated, OTH for other.
BankAccountNameStringThe Name of the Hotels Bank account
BookingFormTrackingCodeStringWhen the Booking form is displayed for this ap, this script or image is inserted into the page for tracking purposes.
BankAccountNumberStringThe Bank Account number for the Hotels bank account
BankIdentifierCodeStringAn Indeitifer for the Bank Account
BankNameStringThe name of the Banking institution where the Hotels bank account is kept
BranchNameStringThe Branch for the Bank Account
BSBNumberStringThe Bank accounts Bank State Branch Number
BankAccountSuffixStringThe Bank Accounts Suffix
EmailStringAn Email Address to use when contacting the Hotel for general use.
FaxStringThe Hotels General Fax Number
ManagerStringThe Managers name for the Hotel
MaximumArrivalTimeStringThe Maximum arrival time on a day, this is stored as 4 digits, eg, 2300 is 11pm
MaximumDepartureTimeStringThe Maximum departure time on a day, this is stored as 4 digits, eg, 1200 is 12pm
MinimumArrivalTimeStringThe minimum Arrival Time on a day, this is stored as 4 digits, eg, 1030 is 10:30 am
MinimumDepartureTimeStringThe Minimum Departure Time on a day, this is stored as 4 digits, eg, 0420 is 4:20 am
NotesStringAny Notes about the Hotel, this is not displayed anywhere.
PrimaryPhoneNumberStringThe Hotels Primary Phone Number
TaxRegistrationNumberStringThe Hotels tax Number, in Australia this is known as the ABN.
TaxTypeStringThe Hotels Tax Type, eg GST = Registered for GST, INT = Input Tax Registered, N/T = Not Registered for Tax in Australia.
BookingConfirmationTextStringWhen a Booking is confirmed, display this additional text on the Booking confirmation, and Confirmation Emails.
WebsiteURLStringThe Hotels main Website URL, eg, http://www.greathotel.com.au
QtyRoomsInt64The estimated Qty of Rooms that the Hotel/Property has for sale
AddressesList of HotelAddressA List of Address Data for the Hotel
DescriptionsList of HotelDescriptionA List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc...
ImagesList of HotelImageA List of Property Images
HotelTypesList of HotelTypeA List of Hotel Types that categorize the Hotel. Normally you would only have one type attached (eg, Hotel), but the system does cater for more than 1.
For a list of valid HotelTypes you can call GetStaticData.
HotelUsersList of HotelUserA List of Users that are allowed to login to the Extranet and view / modify information relating to this Hotel.
FeaturesList of HotelFeatureA List of Features that describe what facilities or amenities the Hotel has
ContactsList of HotelContactA List of Contacts for your Hotel.
TimezoneIdentifierStringThe timezone of the Hotel
HotelRegistrationHotelRegistrationHotel Registration and Exemption Codes for properties that require them.

HotelAddress

A List of Address Data for the Hotel

Field Data Type Description
HotelAddressIDInt64A Unique Identifier to identify the Hotel Address, if you are using this object to attach a new Address to a Hotel, specify nil or 0
AddressTypeStringType of Address, Street or Postal
AddressLine1StringThe Address line with the highest Priority, it is Also Mandatory
AddressLine2String2nd Address Line if required
AddressLine3String3rd Address Line if required
AddressLine4String4th Address Line if required
SuburbStringSuburb
CityStringCity
StateStringState as a String, eg, QLD, or Queensland
PostcodeStringPostcode for the Address
CountryISOStringThe Country ID

HotelDescription

A List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc...

Field Data Type Description
HotelDescriptionIDInt64A Unique Identifer to identify the Hotel Description, if you are using this object to Attach a new Description to the Hotel, specify nil or 0
DescriptionCodeStringCode for the Description, STR = Street, POS = Postal
DescriptionNameStringName of the Description
ValueStringThe Description Value

HotelImage

A List of Property Images

Field Data Type Description
HotelImageIDInt64A Unique Identifier for this Hotel Image, if you are using this object to create a new image against the hotel, specify nil or 0
DisplaySequenceInt64Use this to display the images in the order specified by the hotel
LargeUrlStringThe URL where the Large version of the image resides.
ThumbUrlStringThe URL where the Thumbnail version of the image resides.
ToolTipTextStringWhen a mouse is hovered over the Image, display this text.
HeroImageBooleanHero Image: This image can be used as the main image on listing pages. If this element is missing, then HeroImage = false
WidthInt64Width of the large version of this image.
HeightInt64Height of the large version of this image.

HotelType

A List of Hotel Types that categorize the Hotel. Normally you would only have one type attached (eg, Hotel), but the system does cater for more than 1.
For a list of valid HotelTypes you can call GetStaticData.

Field Data Type Description
HotelTypeIDInt64A Unique Identifier for this Hotel Type, if you are using this object to attach a new HotelType to the Hotel, specify nil or 0
HotelTypeCodeStringThe Hotel Type Code, possible values are (Cabin,Chalet,Houseboat,Lodge,Villa,Cottage,Apartment,B&B,Backpacker / Hostel,Condo,Guest House,Hotel,Motel,Private Apartment,Resort,Tourist / Caravan Park,Holiday House,Holiday Park)

HotelUser

A List of Users that are allowed to login to the Extranet and view / modify information relating to this Hotel.

Field Data Type Description
HotelUserIDInt64A Unique Identifier to identify the User, if you are using this object to attach a New HotelUser to the Hotel, specify nil or 0
FirstNameStringUsers First Name
LastNameStringUsers Last Name
EmailAddressStringUsers Email Address
UsernameStringUsers Username
PasswordStringUsers Password
RoleStringRole type / or group, Eg, Administrator, Reservations, Accounts, Reception
MobileStringUsers Mobile Number

HotelFeature

A List of Features that describe what facilities or amenities the Hotel has

Field Data Type Description
HotelFeatureIDInt64A Unique Identifier to identify the Hotel Feature, if you are using this object to create a new feature, specify nil or 0
NameStringThe name of the Feature, this text is displayed on the Websites when promoting the Hotel
DisplaySequenceInt64The Display Sequence, or order that that the feature should be positioned when displaying the Feature on the Hotels Sales Page.

HotelContact

A List of Contacts for your Hotel.

Field Data Type Description
HotelContactIdInt64A Unique Identifier for this Hotel Contact, if you are using this object to create a new Contact against the hotel, specify nil or 0
TitleStringThe Title of this Hotel Contact. For Example: Mr, Mrs.
EmailAddressStringThe Hotel Contact Email Address.
FirstNameStringThe Hotel Contact First Name
PhoneNumberStringThe Hotel Contact Contact Phone Number
LastNameStringThe Hotel Contact Surname.
MobileNumberStringThe Hotel Contact Mobile Phone Number
ContactPositionStringThe position of the hotel contact in your company, General Manager, Office Manager
FaxNumberStringThe Hotel Contact Fax Number.

HotelRegistration

Hotel Registration and Exemption Codes for properties that require them.

Field Data Type Description
RegistrationNumberStringAn Optional Registration Number such as STRA Number
RegistrationDateDateTimeDate Registration was acquired
RegistrationExpiryDateTimeRegistration Expiry Date
RegistrationExemptionStringAn code making the property exempt of requiring Registration (Only required if the property resides within an area requiring Registration)
UpdateAllChannelsBooleanSet to true to push to all OTA distribution channels

TimeSpan

Field Data Type Description

SaveHotelResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelIdInt64If the Operation is saving a new hotel, then Generated HotelID is supplied here, else it will be the HotelID that was updated, which will match the HotelID supplied in the request
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

SaveHotelDCFees

Save or update distribution fees

SaveHotelDCFeesResponse SaveHotelDCFees(SaveHotelDCFeesRequest request)

Method Parameters

Field Data Type Description
requestSaveHotelDCFeesRequest

SaveHotelDCFeesRequest

Field Data Type Description
DistributionChannelCodeStringThe code for the distribution channel.
HotelDistributionFeesList of HotelDistributionFeeA List of DC Fee Objects
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelDistributionFee

A List of DC Fee Objects

Field Data Type Description
FeeIdInt64This is the unique identifier for your Distribution Fee.
When you are creating a new fee you must set this value to 0.
When updating an already existing fee it must be set to a valid fee Id for your username and password.
FeeCodeStringThis is the code used to set the type of fee. This must match a fee type support by this distribution channel.
FeeAmountDecimalThis is the amount of the fee charged to the guest.
HotelIdInt64The unique HotelID
FeeSettingsList of HotelDistributionFeeSettingA list of settings for a fee.
RatePackageIdsList of Int64A list of rate package ids that the fee will apply to.

HotelDistributionFeeSetting

A list of settings for a fee.

Field Data Type Description
FeeIdInt64This is the unique identifier for your distribution fee.
This Id must match the parent Id of this setting.
SettingIdInt64This is the unique identifier for your Distribution Fee Setting.
Set this to 0 if this is a new setting.
SettingCodeStringThe unique code of the setting
SettingValueStringOptional field used by some setting options
HotelDistributionFeeRestrictionsList of HotelDistributionFeeRestrictionOption field used to define fee rules for applicable fee settings

HotelDistributionFeeRestriction

Option field used to define fee rules for applicable fee settings

Field Data Type Description
RestrictionIdInt64This is the unique identifier for your distribution fee restriction.
Set this to 0 if this is a new restriction.
SettingIdInt64This is the unique identifier for your distribution fee setting.
This Id must match the parent Id of this restriction.
RestrictionCodeString
MinNumberDecimal
MaxNumberDecimal
MinDateDateTime
MaxDateDateTime
DaysOfWeekList of Int64A number between 1 - 7 representing a day of the week starting at Sunday.

TimeSpan

Field Data Type Description

SaveHotelDCFeesResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
FeesAffectedList of Int64All Fee ids affected are returned here. If you create a new fee the ID will also be in here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

SaveHotelExtras

SaveHotelExtras is used to update or save the extras for a hotel

HotelExtrasSaveResponse SaveHotelExtras(HotelExtrasSaveRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestHotelExtrasSaveRequest

HotelExtrasSaveRequest

Field Data Type Description
HotelExtrasList of HotelExtraThe hotel rate package deals to be saved
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelExtra

The hotel rate package deals to be saved

Field Data Type Description
HotelExtraIdInt64The unique HotelExtraId
HotelIdInt64The unique HotelId
HotelExtraTypeHotelExtraTypeThe HotelExtraType for this HotelExtra
NameStringThe Name of the HotelExtra
DescriptionStringThe description of the HotelExtra
AmountDecimalThe amount of the HotelExtra - Not required for Per Person HotelExtraType
AdultAmountDecimalThe adult amount of the HotelExtra - Required for Per Person HotelExtraType
ChildAmountDecimalThe child amount of the HotelExtra - Required for Per Person HotelExtraType
RatePackageIdsRatePackageIdsList is rate plans that this hotel extra applies to. If none are specified then all rate plans apply.
RoomTypeIdsRoomTypeIdsList is room types that this hotel extra applies to. If none are specified then all room types apply.

HotelExtraType

The HotelExtraType for this HotelExtra

Field Data Type Description
BOOPer Booking
NGTPer Night
PERPer Person
QTYPer Quantity

RatePackageIds

List is rate plans that this hotel extra applies to. If none are specified then all rate plans apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

RoomTypeIds

List is room types that this hotel extra applies to. If none are specified then all room types apply.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

TimeSpan

Field Data Type Description

HotelExtrasSaveResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelExtrasHotelExtrasA List of HotelExtras that were saved / created.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

HotelExtras

A List of HotelExtras that were saved / created.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

SaveHotelRatePackageDeals

SaveHotelRatePackageDeals is used to save the Deals attached to a HotelRatePackage. Specify 0 for the HotelRatePackageDealId and it will create a new one for you.

HotelRatePackageDealsSaveResponse SaveHotelRatePackageDeals(HotelRatePackageDealsSaveRequest request)

Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://cm.schema.com/direct/2.0/" xmlns:ns="http://cm.schema.com/api-core/2.0/" xmlns:roam="http://schemas.datacontract.org/2004/07/DirectApi.Service.Content.Model" xmlns:sys="http://schemas.datacontract.org/2004/07/System">
   <soapenv:Header/>
   <soapenv:Body>
      <con:SaveHotelRatePackageDeals>
         <!--Optional:-->
         <con:request>
            <ns:ChannelManagerUsername>?</ns:ChannelManagerUsername>
            <ns:ChannelManagerPassword>?</ns:ChannelManagerPassword>
            <!--Optional:-->
            <ns:Username>?</ns:Username>
            <!--Optional:-->
            <ns:Password>?</ns:Password>
            <!--Optional:-->
            <roam:HotelID>184424</roam:HotelID>
            <!--Optional:-->
            <roam:HotelRatePackageDeals>
               <!--Zero or more repetitions:-->
               <con:HotelRatePackageDeal>
                  <!--Optional:-->
                  <con:CloseOut>28</con:CloseOut>
                  <!--Optional:-->
                  <con:DatesRangesExcluded>
                     <!--Zero or more repetitions:-->
                     <con:DateRange>
                        <con:From>2010-07-01</con:From>
                        <con:To>2010-07-31</con:To>
                     </con:DateRange>
                  </con:DatesRangesExcluded>
                  <!--Optional:-->
                  <con:DaysOfWeekExcluded>
                     <!--Zero or more repetitions:-->
                     <sys:DayOfWeek>Tuesday</sys:DayOfWeek>
                  </con:DaysOfWeekExcluded>
                  <con:Description>Hello Description</con:Description>
                  <!--Optional:-->
                  <con:Discount>10</con:Discount>
                  <con:EndDate>2010-09-30</con:EndDate>
                  <con:HotelRatePackageId>38447</con:HotelRatePackageId>
                  <con:HotelRatePackageDealId>0</con:HotelRatePackageDealId>
                  <con:HotelRatePackageDealType>DIS</con:HotelRatePackageDealType>
                  <!--Optional:-->
                  <con:PayNights>0</con:PayNights>
                  <!--Optional:-->
                  <con:Repeatable>true</con:Repeatable>
                  <con:StartDate>2010-06-29</con:StartDate>
                  <!--Optional:-->
                  <con:StayNights>0</con:StayNights>
               </con:HotelRatePackageDeal>
            </roam:HotelRatePackageDeals>
         </con:request>
      </con:SaveHotelRatePackageDeals>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field Data Type Description
requestHotelRatePackageDealsSaveRequest

HotelRatePackageDealsSaveRequest

Field Data Type Description
HotelRatePackageDealsList of HotelRatePackageDealThe hotel rate package deals to be saved
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelRatePackageDeal

The hotel rate package deals to be saved

Field Data Type Description
HotelRatePackageDealIdInt64The unique HotelRatePackageDealId
HotelRatePackageIdInt64The unique HotelRatePackageId
HotelRatePackageNameStringThe Name of the HotelRatePackage
DescriptionStringThe description of the deal eg. (Stay 7 nights pay 5 nights)
ShortDescriptionStringThe description of the deal eg. (Stay 7 nights pay 5 nights)
StartDateDateTimeStarting Date for the deal
EndDateDateTimeEnd Date for the deal
BookableStartDateDateTimeFirst date upon which the deal may be booked
BookableEndDateDateTimeLast date upon which the deal may be booked
HotelRatePackageDealTypeHotelRatePackageDealTypeThe type of the deal
StayNightsInt64The number of nights that can be stayed
PayNightsInt64The number of nights that must be paid for
RepeatableBooleanIs this deal repeatable?
DiscountDecimalDiscount off the standard rate
CloseOutInt64Maximum number of days before check in this deal is available for
CloseOutTypeStringHow the Closeout field should be handled, BEF = Before Arrival, AFT = after arrival.
DatesRangesExcludedList of DateRangeList of dates that deal does not apply to
DaysOfWeekExcludedList of DayOfWeekDays of the week that this deal does not apply to
PackageNightsInt64The number of nights the package rate applies for
PackageRateDecimalThe alternate rate for the package
PackageRateContinuesBooleanDoes the rate for this package continue past the number of package days. Otherwise it falls back to the standard rate
SearchRatePackageIdInt64Use this ID to attach to the RoomId field in the booking form. This id is the same id that the booking form uses to book this Special. This field is a read only field. On save messages, leave this field out or set it to null
ValidForHotelVoucherOnlyBooleanIs this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher?
NoVoucherDiscountAppliesBooleanIs this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher?
DCMappingsList of SpecialDCMappingYou can map a special to a channel and market it as a special which should be sent to them. If you want to remove a mapping which is already in the system, simply do not supply it in this list and it will be removed.

HotelRatePackageDealType

The type of the deal

Field Data Type Description
SPYStay Pay
DISPercentage Discount
DIVValue Discount
PKGPackage Deal

DateRange

List of dates that deal does not apply to

Field Data Type Description
FromDateTime
ToDateTime

DayOfWeek

Days of the week that this deal does not apply to

Field Data Type Description

SpecialDCMapping

You can map a special to a channel and market it as a special which should be sent to them. If you want to remove a mapping which is already in the system, simply do not supply it in this list and it will be removed.

Field Data Type Description
DCCodeStringThe Distribution Channel code the mapping is for. You can get a list of possible distribution channels using the GetStaticData message.
SourceSpecialIdStringThis is the distribution channels unique identifier for the special which is created. Set this to an Empty string when you are creating a new mapping. Also, this field is read only, so setting it to a value will not make any changes
SettingsList of SpecialDCSettingEach channel can have custom parameters which they want to be sent to them when saving a Mapping. To get this list of possibilities, please contact our support team as the list is different for each channel and we have no API call that you can use to get them yet.

SpecialDCSetting

Each channel can have custom parameters which they want to be sent to them when saving a Mapping. To get this list of possibilities, please contact our support team as the list is different for each channel and we have no API call that you can use to get them yet.

Field Data Type Description
KeyStringThe Unique key code for the setting.
ValueStringThe Value specified. Any dates must be saved in the format yyyy-MM-dd HH24:mi:ss. Any booleans must be true or false.

TimeSpan

Field Data Type Description

HotelRatePackageDealsSaveResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
HotelRatePackageDealsHotelRatePackageDealsA List of Deals that were saved / created.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

HotelRatePackageDeals

A List of Deals that were saved / created.

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

SaveHotelRentalAgreement

Save Rental Agreement for a hotel

SaveRentalAgreementResponse SaveHotelRentalAgreement(SaveRentalAgreementRequest request)

Method Parameters

Field Data Type Description
requestSaveRentalAgreementRequest

SaveRentalAgreementRequest

Field Data Type Description
PdfDataStringBase64 encoded dump of the file data, eg the contents of the pdf file
FileNameStringThe Filename for this pdf, note this is not the URL but just the filename and extension. It should not contain the directory path either.
RentalAgreementIdInt64The rental agreement Id of an existing rental agreement. Set this to 0 if this is a new rental agreement.
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

SaveRentalAgreementResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

SaveHotelRooms

SaveHotelRooms is used to save the Rooms attached to a hotel. Specify 0 for the HotelRoomId and it will create a new one for you.

SaveHotelRoomsResponse SaveHotelRooms(SaveHotelRoomsRequest request)

Method Parameters

Field Data Type Description
requestSaveHotelRoomsRequest

SaveHotelRoomsRequest

Field Data Type Description
HotelRoomsList of HotelRoomA List of HotelRoom Objects
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelRoom

A List of HotelRoom Objects

Field Data Type Description
VersionInt64
HotelRoomIdInt64The unique HotelRoomId
HotelIdInt64The unique HotelID
NameStringThe name of the Hotel Room.
DescriptionStringThe description of the hotel room.
BedConfigurationStringThe Bedding Configuration for the hotel room.
LowAvailabilityQtyInt64The Low availability hotel room quantity.
QtyPhysicalBedroomsInt64The Qty of Bedrooms in this Room.
QtyBathroomsInt64The Qty of Bathrooms, please don't include Ensuites in this qty.
QtyEnsuitesInt64The Qty of Ensuites. Please don't include ensuites in the QtyBathrooms field.
RoomTypeFeaturesList of HotelRoomFeatureA List of Hotel Room Features. The Hotel Room Features Available for your Hotel type can be found by querying static data.
RatePackagesList of HotelRatePackageA List of Rate Packages or "Ways to sell this Room".
AutoFillOptionsRoomAutoFillOptionsWe use the same HotelRoom object for Both Save and Read, so when creating a new Room, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests
ImagesImageIdentifiersThe image identifiers attached to this room. The ids can be obtained from the GetHotelDetail message
RoomHeroImageIdInt64The image id that the property wishes to be displayed as the hero image. This id references to the image ids that are returned from the the GetHotel message.
BedroomsList of HotelRoomBedroomThe Bedrooms in this room and the bedding configurations of each.
BathroomsList of HotelRoomBathroomThe Bathrooms in this room and the features present in each.
PMSRoomCodeStringThe unique ID for the PMS system which is creating this room. This field is useful to map between Resonline's IDs and your unique Id.
UnitAreaInt64The area of the room that is available to guests.
UnitAreaTypeStringThe measurement type for the area of the room. Either SQM - Square Meters or SQF - Square Feet.

HotelRoomFeature

A List of Hotel Room Features. The Hotel Room Features Available for your Hotel type can be found by querying static data.

Field Data Type Description
HotelRoomFeatureIdInt64The unique HotelRoomFeatureId
FeatureTypeIdInt64The unique FeatureTypeId
FeatureTypeNameStringThe unique FeatureTypeName
DisplaySeqInt64The display position for the Hotel Room Feature.

HotelRatePackage

A List of Rate Packages or "Ways to sell this Room".

Field Data Type Description
VersionInt64
HotelRatePackageIdInt64The unique HotelRatePackageId
HotelIdInt64The unique id for the Hotel that this RatePackage is connected to
NameStringThe name of the Hotel Rate Package.
DescriptionStringThe description of the hotel Rate Package.
StandardGuestsInt64The number of guests that the price caters for, once you have more guests, there maybe extra charges which are the Extra*Charges fields.
MaximumGuestsAllowedInt64The maximum number of guests that can be included in this Rate Package. We don't count infants.
ExtraAdultChargeDecimalThe Charge to be applied for every adult guest that is above the StandardGuests value.
ExtraChildChargeDecimalThe Charge to be applied for every child guest that is above the StandardGuests value.
RackRateDecimalRack rate or Standard Rate for this Rate Package.
AutoFillOptionsRateAutoFillOptionsWe use the same HotelRatePackage object for Both Save and Read, so when creating a new RatePackage, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests
LmDefaultsDefaultRateGeneratorAn Object which specifies the Last Minute Defaults to be applied when rolling over new Dates.
YrDefaultsDefaultRateGeneratorAn Object which specifies the Year Round Defaults to be applied when rolling over new Dates.
ImagesImageIdentifiersThe image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message
OpenForSaleFromInt32You can use OpenForSaleFrom and OpenForSaleTo to set restrictions for this rate package on when it can be purchased. Eg, if you have OpenForSaleFrom = 0, and OpenForSaleTo = 90, then bookings can be made in the next 90 days, but afterwards the rate package will no longer be available for sale. Set to Null for no restriction.
OpenForSaleToInt32You can use OpenForSaleFrom and OpenForSaleTo to set restrictions for this rate package on when it can be purchased. Eg, if you have OpenForSaleFrom = 0, and OpenForSaleTo = 90, then bookings can be made in the next 90 days, but afterwards the rate package will no longer be available for sale. Set to Null for no restriction.
RatePlanHeroImageIdInt64The image id that the property wishes to be displayed as the hero image. This id references to the image ids that are returned from the the GetHotel message.
RateOwnerStringThe system that 'owns' the rate. Used to determine which rates can be managed by automated processes
PMSCodeStringA unique identifier which identifies the Property Management systems code for their rate plan equivilent. Useful to determine if a rate plan in your system is already created in our system.
DerivedRatePackagesList of DerivedRatePackageRule for calculating derived rates for this rate package

RateAutoFillOptions

We use the same HotelRatePackage object for Both Save and Read, so when creating a new RatePackage, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests

Field Data Type Description
RateDecimalSet the default Price for this RatePackage for the next 2 years to the value specified.
MinimumNightStayInt32Set the Minimum nights that a guest must stay to qualify for this Rate for the next 2 years to the value specified.
InclusionsStringSet the Inclusion text for each default Rates for the next 2 years to the value specified.

DefaultRateGenerator

An Object which specifies the Last Minute Defaults to be applied when rolling over new Dates.

Field Data Type Description
RatesDayRateGridList of Prices which represents the day of the week, starting at Monday
MinNightsDayMinNightsGridList of Minimum Nights which represents the day of the week, starting at Monday
DefaultInclusionStringOne Inclusion String to be applied to all days when applying defaults.
NumberOfDaysOutInt32The Number of Days from the rollover date for the defaults to be applied.
OverwriteExistingRatesBooleanSet this to True if you want the Default rates to overwrite the existing rates that are stored in the database for this RatePackage. This Object is a shared object, so this field is only used when setting, the value returned when retrieving values is irelevant.

DayRateGrid

List of Prices which represents the day of the week, starting at Monday

Field Data Type Description
MondayDecimal
TuesdayDecimal
WednesdayDecimal
ThursdayDecimal
FridayDecimal
SaturdayDecimal
SundayDecimal
CountInt32

DayMinNightsGrid

List of Minimum Nights which represents the day of the week, starting at Monday

Field Data Type Description
MondayInt32
TuesdayInt32
WednesdayInt32
ThursdayInt32
FridayInt32
SaturdayInt32
SundayInt32
CountInt32

DefaultRateGenerator

An Object which specifies the Year Round Defaults to be applied when rolling over new Dates.

Field Data Type Description
RatesDayRateGridList of Prices which represents the day of the week, starting at Monday
MinNightsDayMinNightsGridList of Minimum Nights which represents the day of the week, starting at Monday
DefaultInclusionStringOne Inclusion String to be applied to all days when applying defaults.
NumberOfDaysOutInt32The Number of Days from the rollover date for the defaults to be applied.
OverwriteExistingRatesBooleanSet this to True if you want the Default rates to overwrite the existing rates that are stored in the database for this RatePackage. This Object is a shared object, so this field is only used when setting, the value returned when retrieving values is irelevant.

DayRateGrid

List of Prices which represents the day of the week, starting at Monday

Field Data Type Description
MondayDecimal
TuesdayDecimal
WednesdayDecimal
ThursdayDecimal
FridayDecimal
SaturdayDecimal
SundayDecimal
CountInt32

DayMinNightsGrid

List of Minimum Nights which represents the day of the week, starting at Monday

Field Data Type Description
MondayInt32
TuesdayInt32
WednesdayInt32
ThursdayInt32
FridayInt32
SaturdayInt32
SundayInt32
CountInt32

ImageIdentifiers

The image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

DerivedRatePackage

Rule for calculating derived rates for this rate package

Field Data Type Description
ParentRatePackageIdInt64RatePackageId that the rate is derived from
DaysFromInt32Days from today to start applying this rule
DaysUntilInt32Days after today to apply this rule
RatePlanDerivationTypeRatePlanDerivationTypeType of rate derivation
DerivedValueDecimalValue used in the derivation calculation
RoundingRoundingHow to round the result

RatePlanDerivationType

Type of rate derivation

Field Data Type Description
PERPercentage
VALValue
MANManually Set

Rounding

How to round the result

Field Data Type Description
UPRound Up
DOWNRound Down
NEARRound to the closest whole
NONENo rounding

RoomAutoFillOptions

We use the same HotelRoom object for Both Save and Read, so when creating a new Room, you can specify Auto Fill Options. AutoFillOptions are not applicable when using this object for Read Requests

Field Data Type Description
QtyRoomsAvailableInt32Set the Qty of Rooms Available for this Room for the next 2 years to the value specified.

ImageIdentifiers

The image identifiers attached to this room. The ids can be obtained from the GetHotelDetail message

Field Data Type Description
CapacityInt32
CountInt32
ItemInt64

HotelRoomBedroom

The Bedrooms in this room and the bedding configurations of each.

Field Data Type Description
BedroomIdInt64The unique BedroomId, set this to zero for new bedrooms
BedroomNoInt64The ordering of bedrooms, e.g 1,2
BedroomNameStringThe name of the Bedroom e.g Master Bedroom
EnsuiteBooleanWhether the Bedroom has an en suite
BedroomTypeStringThe name of the bedroom type for display purposes only
RoomTypeIdInt64The unique room id this bedroom belongs to
BeddingConfigurationsList of HotelRoomBeddingConfigThe list of bedding configurations this bedroom can have
BedroomTypeCodeStringThe bedroom type code

HotelRoomBeddingConfig

The list of bedding configurations this bedroom can have

Field Data Type Description
BeddingConfigIdInt64The unique bedding config id, set to zero for new configs
BedroomIdInt64The unique bedroom id this config belongs to
DefaultConfigBooleanSet to true to mark this config as the default config or setup for this room
BedsList of HotelRoomBedsThe list of beds within this configuration

HotelRoomBeds

The list of beds within this configuration

Field Data Type Description
BedTypeStringThe bed type code
NameStringThe name of the bed type, for display purposes
AmountInt64The amount of beds supplied for this config/room

HotelRoomBathroom

The Bathrooms in this room and the features present in each.

Field Data Type Description
BathroomIdInt64The unique bathroom id for this bathroom, set to zero for new bathrooms
RoomTypeIdInt64The unique room id that this bathroom belongs to
BathroomTypeIdInt64The internal id of the bathroom type
BathroomNumberInt64The ordering of the bathrooms.
BathroomTypeStringThe bathroom type code
BathroomFeaturesList of HotelRoomBathroomFeatureThe list of amenities within this bathroom

HotelRoomBathroomFeature

The list of amenities within this bathroom

Field Data Type Description
BathroomFeatureIdInt64The internal id of this bathroom feature type
BathroomFeatureCodeStringThe code of this bathroom feature type
BathroomFeatureNameStringThe name of this bathroom feature type
BathroomIdInt64The unique bathroom id that this feature belongs to
AmountInt64The amount of this feature within this bathroom

TimeSpan

Field Data Type Description

SaveHotelRoomsResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
RoomsAffectedList of Int64All room ids affected are returned here. If you create a new room the ID will also be in here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

SaveHotelVouchers

SaveHotelVouchers is used to update or save the vouchers for a Hotel

HotelVoucherSaveResponse SaveHotelVouchers(HotelVoucherSaveRequest request)

Example

TODO

Method Parameters

Field Data Type Description
requestHotelVoucherSaveRequest

HotelVoucherSaveRequest

Field Data Type Description
HotelVouchersList of HotelVoucherThe hotel vouchers deals to be saved
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

HotelVoucher

The hotel vouchers deals to be saved

Field Data Type Description
HotelIdInt64The unique HotelId
CodeStringThe unique code
DescriptionStringDescription
TypeHotelVoucherTypeThe type of hotel voucher
AmountDecimalThe type of hotel voucher
ActiveBooleanActive
AppliesToAllRatePackagesBooleanApplies to all rate packages
AppliesToAllRatePackageDealsBooleanAll Rate Package Deals can be unlocked using this voucher
RatePackagesRatePackageIdsList of Rate Package Identifiers that will have the voucher applied to them
RatePackageDealsRatePackageDealIdsList of Rate Package Deal Identifiers that will have the voucher applied to them
PaymentNotRequiredBooleanPayment is not required at booking time when using this voucher
CurrentCodeStringThe current code of the voucher needs to be specified if the voucher code is required to be changed

HotelVoucherType

The type of hotel voucher

Field Data Type Description
PerPercentage Discount
ValValue Reduction

RatePackageIds

List of Rate Package Identifiers that will have the voucher applied to them

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

RatePackageDealIds

List of Rate Package Deal Identifiers that will have the voucher applied to them

Field Data Type Description
CapacityInt32
CountInt32
ItemInt32

TimeSpan

Field Data Type Description

HotelVoucherSaveResponse

Field Data Type Description
SuccessBooleanIndicates if the operation was successful or not.
ErrorCodeStringIf there was an error, the error code is returned here.
MessageStringSuccess and Error Information is returned here.
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString

SaveOtaCancellationPolicy

SaveOtaCancellationPolicyResponse SaveOtaCancellationPolicy(SaveOtaCancellationPolicyRequest request)

Method Parameters

Field Data Type Description
requestSaveOtaCancellationPolicyRequest

SaveOtaCancellationPolicyRequest

Field Data Type Description
ChannelCodeString
PolicyCodeString
ChannelManagerUsernameStringChannel Managers Username as supplied when the Channel Manager Agreement was made
ChannelManagerPasswordStringChannel Managers password as supplied when the Channel Manager Agreement was made
UsernameStringHotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel
PasswordStringHotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel
HotelIdInt64The HotelID that you want to work with. This software can access more than one hotel from the same username and password.
HotelAuthenticationKeyStringAuthentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password.

TimeSpan

Field Data Type Description

SaveOtaCancellationPolicyResponse

Field Data Type Description
SuccessBoolean
MessageString
TimestampDateTime
MessageIdString
HotelAuthenticationKeyString