ContentService
ActivateProperty
Activate a Property
ActivatePropertyResponse ActivateProperty(ActivatePropertyRequest request)
Method Parameters
Field | Data Type | Description |
request | ActivatePropertyRequest |
ActivatePropertyRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. The ActivationFailureFault Fault will be thrown if not. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
AddAPImage
DirectAPIAddAPImage_Response AddAPImage(DirectAPIAddAPImageRequest request)
Method Parameters
Field | Data Type | Description |
request | DirectAPIAddAPImageRequest |
DirectAPIAddAPImageRequest
Field | Data Type | Description |
LargeImageData | String | Base64 encoded dump of the image data, eg the contents of a jpg file |
LargeImageFileName | String | The Filename for this image, not this is not the URL but just the Filename and extension. It should not contain the directory path either. |
ToolTipText | String | When the mouse cursor hovers over this image in the website(s), what hover text should be displayed to describe this image to the user. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelImageID | Int64 | Unique identifier for this image |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
CopyHotelRatePackage
CopyHotelRatePackage is used to Delete a Room for a hotel.
CopyHotelRatePackageResponse CopyHotelRatePackage(CopyHotelRatePackageRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | CopyHotelRatePackageRequest |
CopyHotelRatePackageRequest
Field | Data Type | Description |
HotelRatePackageId | Int64 | The Hotel Rate Package Id of the Hotel Rate Package you wish to Copy. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeActivateProperty
DeActivate a Property
DeActivatePropertyResponse DeActivateProperty(DeActivatePropertyRequest request)
Method Parameters
Field | Data Type | Description |
request | DeActivatePropertyRequest |
DeActivatePropertyRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. The DeActivationFailureFault Fault will be thrown if not. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteBookingQuestion
DeleteBookingQuestion is used to remove an extra from a hotel
DeleteBookingQuestionResponse DeleteBookingQuestion(DeleteBookingQuestionRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | DeleteBookingQuestionRequest |
DeleteBookingQuestionRequest
Field | Data Type | Description |
BookingQuestionId | Int64 | The Booking Questions to be deleted |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteHotelBathroom
DelHotelBathroomResponse DeleteHotelBathroom(DelHotelBathroomRequest request)
Method Parameters
Field | Data Type | Description |
request | DelHotelBathroomRequest |
DelHotelBathroomRequest
Field | Data Type | Description |
HotelBathrooms | HotelBathrooms | |
RoomTypeId | Int64 | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
TimeSpan
Field | Data Type | Description |
DelHotelBathroomResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteHotelBedConfig
DelHotelBedConfigResponse DeleteHotelBedConfig(DelHotelBedConfigRequest request)
Method Parameters
Field | Data Type | Description |
request | DelHotelBedConfigRequest |
DelHotelBedConfigRequest
Field | Data Type | Description |
HotelBedConfigs | HotelBedConfig | |
RoomTypeId | Int64 | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
TimeSpan
Field | Data Type | Description |
DelHotelBedConfigResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteHotelBedroom
DelHotelBedroomResponse DeleteHotelBedroom(DelHotelBedroomRequest request)
Method Parameters
Field | Data Type | Description |
request | DelHotelBedroomRequest |
DelHotelBedroomRequest
Field | Data Type | Description |
HotelBedrooms | HotelBedroom | |
RoomTypeId | Int64 | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
TimeSpan
Field | Data Type | Description |
DelHotelBedroomResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteHotelDCFees
delete distribution fees for a hotel
DeleteHotelDCFeesResponse DeleteHotelDCFees(DeleteHotelDCFeesRequest request)
Method Parameters
Field | Data Type | Description |
request | DeleteHotelDCFeesRequest |
DeleteHotelDCFeesRequest
Field | Data Type | Description |
DistributionChannelCode | String | The unique code for the distribution channel. |
FeeIds | List of Int64 | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
FeesAffected | List of Int64 | All room ids affected are returned here. If you create a new room the ID will also be in here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteHotelExtra
DeleteHotelExtra is used to remove an extra from a hotel
HotelExtraDeleteResponse DeleteHotelExtra(HotelExtraDeleteRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | HotelExtraDeleteRequest |
HotelExtraDeleteRequest
Field | Data Type | Description |
HotelExtraId | Int64 | The hotel extra to be deleted |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteHotelRentalAgreement
Delete Rental Agreement for a hotel
DelRentalAgreementResponse DeleteHotelRentalAgreement(DelRentalAgreementRequest request)
Method Parameters
Field | Data Type | Description |
request | DelRentalAgreementRequest |
DelRentalAgreementRequest
Field | Data Type | Description |
RentalAgreementId | Int64 | The rental agreement Id |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DeleteHotelVoucher
DeleteHotelVoucher is used to remove a voucher from a hotel
HotelVoucherDeleteResponse DeleteHotelVoucher(HotelVoucherDeleteRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | HotelVoucherDeleteRequest |
HotelVoucherDeleteRequest
Field | Data Type | Description |
HotelVoucherCode | String | The hotel voucher to be deleted |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelAddress
DelHotelAddress is used to delete a hotel Address for a specified hotel.
DelHotelAddressResponse DelHotelAddress(DelHotelAddressRequest request)
Example
<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 |
request | DelHotelAddressRequest |
DelHotelAddressRequest
Field | Data Type | Description |
HotelAddressId | Int64 | The Hotel Address Id of the Address you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelContact
DelHotelContact is used to delete a contact for a specified hotel.
DelHotelContactResponse DelHotelContact(DelHotelContactRequest request)
Example
<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 |
request | DelHotelContactRequest |
DelHotelContactRequest
Field | Data Type | Description |
HotelContactId | Int64 | The Hotel Contact Id of the contact you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelDescription
DelHotelDescription is used to delete a hotel Description for a specified hotel.
DelHotelDescriptionResponse DelHotelDescription(DelHotelDescriptionRequest request)
Example
<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 |
request | DelHotelDescriptionRequest |
DelHotelDescriptionRequest
Field | Data Type | Description |
HotelDescriptionId | Int64 | The Hotel Description Id of the description you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelFeature
DelHotelFeature is used to delete a Feature for a specified hotel.
DelHotelFeatureResponse DelHotelFeature(DelHotelFeatureRequest request)
Example
<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 |
request | DelHotelFeatureRequest |
DelHotelFeatureRequest
Field | Data Type | Description |
HotelFeatures | HotelFeatures | A List of Hotel Feature Ids which you want to remove. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
TimeSpan
Field | Data Type | Description |
DelHotelFeatureResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelImage
DelHotelImage is used to delete an image for a specified hotel.
DelHotelImageResponse DelHotelImage(DelHotelImageRequest request)
Example
<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 |
request | DelHotelImageRequest |
DelHotelImageRequest
Field | Data Type | Description |
HotelImageId | Int64 | The Hotel Image Id of the Image you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelRatePackage
DelHotelRatePackage is used to Delete a Rate Package for a hotel.
DelHotelRatePackageResponse DelHotelRatePackage(DelHotelRatePackageRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | DelHotelRatePackageRequest |
DelHotelRatePackageRequest
Field | Data Type | Description |
HotelRatePackageId | Int64 | The Hotel Rate Package Id of the Hotel Rate Package you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelRatePackageDeal
DelHotelRatePackageDeal is used to Delete a Rate Package Deal for a hotel.
HotelRatePackageDealDeleteResponse DelHotelRatePackageDeal(HotelRatePackageDealDeleteRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | HotelRatePackageDealDeleteRequest |
HotelRatePackageDealDeleteRequest
Field | Data Type | Description |
HotelRatePackageDealId | Int64 | The hotel rate package deals to be deleted |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelRegistration
DelHotelRegistrationResponse DelHotelRegistration(DelHotelRegistrationRequest request)
Method Parameters
Field | Data Type | Description |
request | DelHotelRegistrationRequest |
DelHotelRegistrationRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelRoom
DelHotelRoom is used to Delete a Room for a hotel.
DelHotelRoomResponse DelHotelRoom(DelHotelRoomRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | DelHotelRoomRequest |
DelHotelRoomRequest
Field | Data Type | Description |
HotelRoomId | Int64 | The Hotel Room Id of the Hotel Room you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelRoomFeature
DelHotelRoomFeature is used to delete all Room Features specified in the request for a paricular room.
DelHotelRoomFeaturesResponse DelHotelRoomFeature(DelHotelRoomFeaturesRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | DelHotelRoomFeaturesRequest |
DelHotelRoomFeaturesRequest
Field | Data Type | Description |
HotelRoomFeatureIds | HotelRoomFeatures | The Hotel Room Feature Id of the Hotel Room Feature you wish to delete. |
HotelRoomId | Int64 | The Hotel Room Id that is the parent of the Features you want to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
TimeSpan
Field | Data Type | Description |
DelHotelRoomFeaturesResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelType
DelHotelType is used to delete a hotel type for a specified hotel.
DelHotelTypeResponse DelHotelType(DelHotelTypeRequest request)
Example
<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 |
request | DelHotelTypeRequest |
DelHotelTypeRequest
Field | Data Type | Description |
HotelTypeId | Int64 | The Hotel Type Id of the Hotel Type you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
DelHotelUser
DelHotelUser is used to delete a hotel user for a specified hotel.
DelHotelUserResponse DelHotelUser(DelHotelUserRequest request)
Example
<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 |
request | DelHotelUserRequest |
DelHotelUserRequest
Field | Data Type | Description |
HotelUserId | Int64 | The Hotel User Id of the User you wish to delete. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
GetBookingQuestions
GetBookingQuestions is used to list the current Booking Questions for a Hotel.
BookingQuestionsResponse GetBookingQuestions(BookingQuestionsRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | BookingQuestionsRequest |
BookingQuestionsRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
BookingQuestions | List of BookingQuestion | The Booking Questions List |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
BookingQuestion
The Booking Questions List
Field | Data Type | Description |
BookingQuestionId | Int64 | The unique BookingQuestionId |
HotelId | Int64 | The unique HotelId |
BookingQuestionType | BookingQuestionType | The BookingQuestionType for this BookingQuestion |
Question | String | The Question of the BookingQuestion |
MandatoryResponse | Boolean | The Question required an answer from the guest, or not. |
RatePackageIds | RatePackageIds | List is rate plans that this booking questionapplies to. If none are specified then all rate plans apply. |
RoomTypeIds | RoomTypeIds | List is room types that this booking questionapplies to. If none are specified then all room types apply. |
Options | BookingQuestionOptions | The optional values to be selected for this Booking Question |
BookingQuestionType
The BookingQuestionType for this BookingQuestion
Field | Data Type | Description |
YON | Yes or No | |
TXT | Text | |
MUL | Multiple Choice | |
ALE | None (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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
RoomTypeIds
List is room types that this booking questionapplies to. If none are specified then all room types apply.
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
BookingQuestionOptions
The optional values to be selected for this Booking Question
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | String |
GetClientAutoLoginUrl
ClientAutoLoginUrl GetClientAutoLoginUrl(ClientAutoLoginUrlRequest request)
Method Parameters
Field | Data Type | Description |
request | ClientAutoLoginUrlRequest |
ClientAutoLoginUrlRequest
Field | Data Type | Description |
ClientIpAddress | String | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Url | Uri | Url the client can use to access channel manager |
ExpiryTimeUtc | DateTime | Expiry time UTC after which the provided uri will no longer work. Sessions authenticated with the uri will remain authenticated subject to standard session expiration |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
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 |
request | GetDcBookingFeesRequest |
GetDcBookingFeesRequest
Field | Data Type | Description |
BookingId | Int64 | |
DistributionChannel | String | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
DcBookingFees | List of BookingFee | |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
BookingFee
Field | Data Type | Description |
DcBookingFeeId | Int64 | |
DistributionChannelId | Int64 | |
Amount | Decimal | |
FeeType | String | |
FeeName | String |
GetHotel
GetHotel returns a hotel object for the specified HotelID.
GetHotelResponse GetHotel(GetHotelRequest request)
Example
<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 |
request | GetHotelRequest |
GetHotelRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Hotel | Hotel | The Hotel Object |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
Hotel
The Hotel Object
Field | Data Type | Description |
Version | Int64 | The Version number which is incremented automatically every time something relating to the Hotel has changed in the database |
HotelId | Int64 | This 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. |
Name | String | The Name of the Hotel. Minimum Length: 5 characters. Maximum Length: 100 characters. |
CountryISO | String | The Country ISO of the Country where the Hotel is located. To find a valid Country ISO call GetStaticData. |
CurrencyISO | String | The Preferred Currency that the Hotel Deals in. To find a valid Currency ISO call GetStaticData. |
Latitude | Decimal | Geo-coordinate Latitude |
Longitude | Decimal | Geo-coordinate Longitude |
LocalityId | Int64 | The Locality ID of the Suburb / Location that the hotel is closest to. |
MaxAgeChild | Int32 | The Maximum Age for a child before they will be treated as an adult in regards to calculating booking prices. |
MaxAgeInfant | Int32 | The Maximum age before a guest is considered no longer an infant. |
MinBookingHours | Decimal | The 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. |
PropertyManagementSystemCODE | String | The Property Management System code for the PMS software that the hotel uses (eg, RMS, EZYREZ, HIRUM, OPERA etc...) |
StarRating | Decimal | The Star Rating as given by the Rating Company |
StarRatingMembNum | String | The Star Rating Membership number given to the hotel by the Rating Company. Minimum Length: 1 character. Maximum Length: 20 characters. |
StarRatingType | String | The Star Rating Type Code, eg, SLF for Self Rated, AAA for AAA rated, INT for Internationally Rated, OTH for other. |
BankAccountName | String | The Name of the Hotels Bank account |
BookingFormTrackingCode | String | When the Booking form is displayed for this ap, this script or image is inserted into the page for tracking purposes. |
BankAccountNumber | String | The Bank Account number for the Hotels bank account |
BankIdentifierCode | String | An Indeitifer for the Bank Account |
BankName | String | The name of the Banking institution where the Hotels bank account is kept |
BranchName | String | The Branch for the Bank Account |
BSBNumber | String | The Bank accounts Bank State Branch Number |
BankAccountSuffix | String | The Bank Accounts Suffix |
String | An Email Address to use when contacting the Hotel for general use. | |
Fax | String | The Hotels General Fax Number |
Manager | String | The Managers name for the Hotel |
MaximumArrivalTime | String | The Maximum arrival time on a day, this is stored as 4 digits, eg, 2300 is 11pm |
MaximumDepartureTime | String | The Maximum departure time on a day, this is stored as 4 digits, eg, 1200 is 12pm |
MinimumArrivalTime | String | The minimum Arrival Time on a day, this is stored as 4 digits, eg, 1030 is 10:30 am |
MinimumDepartureTime | String | The Minimum Departure Time on a day, this is stored as 4 digits, eg, 0420 is 4:20 am |
Notes | String | Any Notes about the Hotel, this is not displayed anywhere. |
PrimaryPhoneNumber | String | The Hotels Primary Phone Number |
TaxRegistrationNumber | String | The Hotels tax Number, in Australia this is known as the ABN. |
TaxType | String | The Hotels Tax Type, eg GST = Registered for GST, INT = Input Tax Registered, N/T = Not Registered for Tax in Australia. |
BookingConfirmationText | String | When a Booking is confirmed, display this additional text on the Booking confirmation, and Confirmation Emails. |
WebsiteURL | String | The Hotels main Website URL, eg, http://www.greathotel.com.au |
QtyRooms | Int64 | The estimated Qty of Rooms that the Hotel/Property has for sale |
Addresses | List of HotelAddress | A List of Address Data for the Hotel |
Descriptions | List of HotelDescription | A List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc... |
Images | List of HotelImage | A List of Property Images |
HotelTypes | List of 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. |
HotelUsers | List of HotelUser | A List of Users that are allowed to login to the Extranet and view / modify information relating to this Hotel. |
Features | List of HotelFeature | A List of Features that describe what facilities or amenities the Hotel has |
Contacts | List of HotelContact | A List of Contacts for your Hotel. |
TimezoneIdentifier | String | The timezone of the Hotel |
HotelRegistration | HotelRegistration | Hotel Registration and Exemption Codes for properties that require them. |
HotelAddress
A List of Address Data for the Hotel
Field | Data Type | Description |
HotelAddressID | Int64 | A 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 |
AddressType | String | Type of Address, Street or Postal |
AddressLine1 | String | The Address line with the highest Priority, it is Also Mandatory |
AddressLine2 | String | 2nd Address Line if required |
AddressLine3 | String | 3rd Address Line if required |
AddressLine4 | String | 4th Address Line if required |
Suburb | String | Suburb |
City | String | City |
State | String | State as a String, eg, QLD, or Queensland |
Postcode | String | Postcode for the Address |
CountryISO | String | The Country ID |
HotelDescription
A List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc...
Field | Data Type | Description |
HotelDescriptionID | Int64 | A 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 |
DescriptionCode | String | Code for the Description, STR = Street, POS = Postal |
DescriptionName | String | Name of the Description |
Value | String | The Description Value |
HotelImage
A List of Property Images
Field | Data Type | Description |
HotelImageID | Int64 | A Unique Identifier for this Hotel Image, if you are using this object to create a new image against the hotel, specify nil or 0 |
DisplaySequence | Int64 | Use this to display the images in the order specified by the hotel |
LargeUrl | String | The URL where the Large version of the image resides. |
ThumbUrl | String | The URL where the Thumbnail version of the image resides. |
ToolTipText | String | When a mouse is hovered over the Image, display this text. |
HeroImage | Boolean | Hero Image: This image can be used as the main image on listing pages. If this element is missing, then HeroImage = false |
Width | Int64 | Width of the large version of this image. |
Height | Int64 | Height 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 |
HotelTypeID | Int64 | A Unique Identifier for this Hotel Type, if you are using this object to attach a new HotelType to the Hotel, specify nil or 0 |
HotelTypeCode | String | The 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 |
HotelUserID | Int64 | A Unique Identifier to identify the User, if you are using this object to attach a New HotelUser to the Hotel, specify nil or 0 |
FirstName | String | Users First Name |
LastName | String | Users Last Name |
EmailAddress | String | Users Email Address |
Username | String | Users Username |
Password | String | Users Password |
Role | String | Role type / or group, Eg, Administrator, Reservations, Accounts, Reception |
Mobile | String | Users Mobile Number |
HotelFeature
A List of Features that describe what facilities or amenities the Hotel has
Field | Data Type | Description |
HotelFeatureID | Int64 | A Unique Identifier to identify the Hotel Feature, if you are using this object to create a new feature, specify nil or 0 |
Name | String | The name of the Feature, this text is displayed on the Websites when promoting the Hotel |
DisplaySequence | Int64 | The 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 |
HotelContactId | Int64 | A Unique Identifier for this Hotel Contact, if you are using this object to create a new Contact against the hotel, specify nil or 0 |
Title | String | The Title of this Hotel Contact. For Example: Mr, Mrs. |
EmailAddress | String | The Hotel Contact Email Address. |
FirstName | String | The Hotel Contact First Name |
PhoneNumber | String | The Hotel Contact Contact Phone Number |
LastName | String | The Hotel Contact Surname. |
MobileNumber | String | The Hotel Contact Mobile Phone Number |
ContactPosition | String | The position of the hotel contact in your company, General Manager, Office Manager |
FaxNumber | String | The Hotel Contact Fax Number. |
HotelRegistration
Hotel Registration and Exemption Codes for properties that require them.
Field | Data Type | Description |
RegistrationNumber | String | An Optional Registration Number such as STRA Number |
RegistrationDate | DateTime | Date Registration was acquired |
RegistrationExpiry | DateTime | Registration Expiry Date |
RegistrationExemption | String | An code making the property exempt of requiring Registration (Only required if the property resides within an area requiring Registration) |
UpdateAllChannels | Boolean | Set 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 |
request | GetHotelDCFeesRequest |
GetHotelDCFeesRequest
Field | Data Type | Description |
DistributionChannelCode | String | The unique code for the distribution channel. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Fees | List of DCHotelFee | All room ids affected are returned here. If you create a new room the ID will also be in here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
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 |
FeeId | Int64 | |
FeeDefinitionId | Int64 | |
HotelId | Int64 | |
DistributionChannelId | Int64 | |
DistributionChannel | String | |
FeeName | String | |
FeeCode | String | |
Amount | Decimal | |
DCHotelFeeSettings | List of DCHotelFeeSetting | |
RatePlans | List of DCHotelFeeRatePlan |
DCHotelFeeSetting
Field | Data Type | Description |
SettingId | Int64 | |
SettingTypeId | Int64 | |
DistributionChannelId | Int64 | |
DistributionChannel | String | |
SettingName | String | |
GroupId | Int64 | |
SettingCode | String | |
SettingType | String | |
FeeId | Int64 | |
SettingValue | String | |
DCHotelFeeConstraints | List of DCHotelFeeConstraint |
DCHotelFeeConstraint
Field | Data Type | Description |
ConstraintId | Int64 | |
ConstraintTypeId | Int64 | |
DistributionChannelId | Int64 | |
DistributionChannel | String | |
SettingId | Int64 | |
ConstraintName | String | |
ConstraintCode | String | |
MinDate | DateTime | |
MaxDate | DateTime | |
MinNumber | Decimal | |
MaxNumber | Decimal | |
Days | List of Int64 |
DCHotelFeeRatePlan
Field | Data Type | Description |
RateFeeId | Int64 | |
FeeId | Int64 | |
RatePlanId | Int64 |
GetHotelExtras
GetHotelExtras is used to list the current extras for a Hotel.
HotelExtrasResponse GetHotelExtras(HotelExtrasRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | HotelExtrasRequest |
HotelExtrasRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelExtras | List of HotelExtra | The Hotel Extra List |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
HotelExtra
The Hotel Extra List
Field | Data Type | Description |
HotelExtraId | Int64 | The unique HotelExtraId |
HotelId | Int64 | The unique HotelId |
HotelExtraType | HotelExtraType | The HotelExtraType for this HotelExtra |
Name | String | The Name of the HotelExtra |
Description | String | The description of the HotelExtra |
Amount | Decimal | The amount of the HotelExtra - Not required for Per Person HotelExtraType |
AdultAmount | Decimal | The adult amount of the HotelExtra - Required for Per Person HotelExtraType |
ChildAmount | Decimal | The child amount of the HotelExtra - Required for Per Person HotelExtraType |
RatePackageIds | RatePackageIds | List is rate plans that this hotel extra applies to. If none are specified then all rate plans apply. |
RoomTypeIds | RoomTypeIds | List 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 |
BOO | Per Booking | |
NGT | Per Night | |
PER | Per Person | |
QTY | Per 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
RoomTypeIds
List is room types that this hotel extra applies to. If none are specified then all room types apply.
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
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 |
request | HotelRatePackageDealsRequest |
HotelRatePackageDealsRequest
Field | Data Type | Description |
HotelRatePackageID | Int64 | The HotelRatePackageID for the HotelRatePackageDeals to be returned. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelDeals | List of HotelRatePackageDeal | The Hotel Room Object |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
HotelRatePackageDeal
The Hotel Room Object
Field | Data Type | Description |
HotelRatePackageDealId | Int64 | The unique HotelRatePackageDealId |
HotelRatePackageId | Int64 | The unique HotelRatePackageId |
HotelRatePackageName | String | The Name of the HotelRatePackage |
Description | String | The description of the deal eg. (Stay 7 nights pay 5 nights) |
ShortDescription | String | The description of the deal eg. (Stay 7 nights pay 5 nights) |
StartDate | DateTime | Starting Date for the deal |
EndDate | DateTime | End Date for the deal |
BookableStartDate | DateTime | First date upon which the deal may be booked |
BookableEndDate | DateTime | Last date upon which the deal may be booked |
HotelRatePackageDealType | HotelRatePackageDealType | The type of the deal |
StayNights | Int64 | The number of nights that can be stayed |
PayNights | Int64 | The number of nights that must be paid for |
Repeatable | Boolean | Is this deal repeatable? |
Discount | Decimal | Discount off the standard rate |
CloseOut | Int64 | Maximum number of days before check in this deal is available for |
CloseOutType | String | How the Closeout field should be handled, BEF = Before Arrival, AFT = after arrival. |
DatesRangesExcluded | List of DateRange | List of dates that deal does not apply to |
DaysOfWeekExcluded | List of DayOfWeek | Days of the week that this deal does not apply to |
PackageNights | Int64 | The number of nights the package rate applies for |
PackageRate | Decimal | The alternate rate for the package |
PackageRateContinues | Boolean | Does the rate for this package continue past the number of package days. Otherwise it falls back to the standard rate |
SearchRatePackageId | Int64 | Use 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 |
ValidForHotelVoucherOnly | Boolean | Is this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher? |
NoVoucherDiscountApplies | Boolean | Is this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher? |
DCMappings | List of 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. |
HotelRatePackageDealType
The type of the deal
Field | Data Type | Description |
SPY | Stay Pay | |
DIS | Percentage Discount | |
DIV | Value Discount | |
PKG | Package Deal |
DateRange
List of dates that deal does not apply to
Field | Data Type | Description |
From | DateTime | |
To | DateTime |
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 |
DCCode | String | The Distribution Channel code the mapping is for. You can get a list of possible distribution channels using the GetStaticData message. |
SourceSpecialId | String | This 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 |
Settings | List of 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. |
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 |
Key | String | The Unique key code for the setting. |
Value | String | The 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 |
request | GetRentalAgreementRequest |
GetRentalAgreementRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
HotelId | Int64 | |
AgreementId | Int64 | |
FileName | String | |
FileUrl | String | |
DateModified | DateTime | |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
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 |
request | GetHotelRoomsRequest |
GetHotelRoomsRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelRooms | List of HotelRoom | The Hotel Room Object |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
HotelRoom
The Hotel Room Object
Field | Data Type | Description |
Version | Int64 | |
HotelRoomId | Int64 | The unique HotelRoomId |
HotelId | Int64 | The unique HotelID |
Name | String | The name of the Hotel Room. |
Description | String | The description of the hotel room. |
BedConfiguration | String | The Bedding Configuration for the hotel room. |
LowAvailabilityQty | Int64 | The Low availability hotel room quantity. |
QtyPhysicalBedrooms | Int64 | The Qty of Bedrooms in this Room. |
QtyBathrooms | Int64 | The Qty of Bathrooms, please don't include Ensuites in this qty. |
QtyEnsuites | Int64 | The Qty of Ensuites. Please don't include ensuites in the QtyBathrooms field. |
RoomTypeFeatures | List of HotelRoomFeature | A List of Hotel Room Features. The Hotel Room Features Available for your Hotel type can be found by querying static data. |
RatePackages | List of HotelRatePackage | A List of Rate Packages or "Ways to sell this Room". |
AutoFillOptions | 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 |
Images | ImageIdentifiers | The image identifiers attached to this room. The ids can be obtained from the GetHotelDetail message |
RoomHeroImageId | Int64 | The 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. |
Bedrooms | List of HotelRoomBedroom | The Bedrooms in this room and the bedding configurations of each. |
Bathrooms | List of HotelRoomBathroom | The Bathrooms in this room and the features present in each. |
PMSRoomCode | String | The 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. |
UnitArea | Int64 | The area of the room that is available to guests. |
UnitAreaType | String | The 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 |
HotelRoomFeatureId | Int64 | The unique HotelRoomFeatureId |
FeatureTypeId | Int64 | The unique FeatureTypeId |
FeatureTypeName | String | The unique FeatureTypeName |
DisplaySeq | Int64 | The display position for the Hotel Room Feature. |
HotelRatePackage
A List of Rate Packages or "Ways to sell this Room".
Field | Data Type | Description |
Version | Int64 | |
HotelRatePackageId | Int64 | The unique HotelRatePackageId |
HotelId | Int64 | The unique id for the Hotel that this RatePackage is connected to |
Name | String | The name of the Hotel Rate Package. |
Description | String | The description of the hotel Rate Package. |
StandardGuests | Int64 | The number of guests that the price caters for, once you have more guests, there maybe extra charges which are the Extra*Charges fields. |
MaximumGuestsAllowed | Int64 | The maximum number of guests that can be included in this Rate Package. We don't count infants. |
ExtraAdultCharge | Decimal | The Charge to be applied for every adult guest that is above the StandardGuests value. |
ExtraChildCharge | Decimal | The Charge to be applied for every child guest that is above the StandardGuests value. |
RackRate | Decimal | Rack rate or Standard Rate for this Rate Package. |
AutoFillOptions | 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 |
LmDefaults | DefaultRateGenerator | An Object which specifies the Last Minute Defaults to be applied when rolling over new Dates. |
YrDefaults | DefaultRateGenerator | An Object which specifies the Year Round Defaults to be applied when rolling over new Dates. |
Images | ImageIdentifiers | The image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message |
OpenForSaleFrom | Int32 | You 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. |
OpenForSaleTo | Int32 | You 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. |
RatePlanHeroImageId | Int64 | The 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. |
RateOwner | String | The system that 'owns' the rate. Used to determine which rates can be managed by automated processes |
PMSCode | String | A 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. |
DerivedRatePackages | List of DerivedRatePackage | Rule 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 |
Rate | Decimal | Set the default Price for this RatePackage for the next 2 years to the value specified. |
MinimumNightStay | Int32 | Set the Minimum nights that a guest must stay to qualify for this Rate for the next 2 years to the value specified. |
Inclusions | String | Set 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 |
Rates | DayRateGrid | List of Prices which represents the day of the week, starting at Monday |
MinNights | DayMinNightsGrid | List of Minimum Nights which represents the day of the week, starting at Monday |
DefaultInclusion | String | One Inclusion String to be applied to all days when applying defaults. |
NumberOfDaysOut | Int32 | The Number of Days from the rollover date for the defaults to be applied. |
OverwriteExistingRates | Boolean | Set 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 |
Monday | Decimal | |
Tuesday | Decimal | |
Wednesday | Decimal | |
Thursday | Decimal | |
Friday | Decimal | |
Saturday | Decimal | |
Sunday | Decimal | |
Count | Int32 |
DayMinNightsGrid
List of Minimum Nights which represents the day of the week, starting at Monday
Field | Data Type | Description |
Monday | Int32 | |
Tuesday | Int32 | |
Wednesday | Int32 | |
Thursday | Int32 | |
Friday | Int32 | |
Saturday | Int32 | |
Sunday | Int32 | |
Count | Int32 |
DefaultRateGenerator
An Object which specifies the Year Round Defaults to be applied when rolling over new Dates.
Field | Data Type | Description |
Rates | DayRateGrid | List of Prices which represents the day of the week, starting at Monday |
MinNights | DayMinNightsGrid | List of Minimum Nights which represents the day of the week, starting at Monday |
DefaultInclusion | String | One Inclusion String to be applied to all days when applying defaults. |
NumberOfDaysOut | Int32 | The Number of Days from the rollover date for the defaults to be applied. |
OverwriteExistingRates | Boolean | Set 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 |
Monday | Decimal | |
Tuesday | Decimal | |
Wednesday | Decimal | |
Thursday | Decimal | |
Friday | Decimal | |
Saturday | Decimal | |
Sunday | Decimal | |
Count | Int32 |
DayMinNightsGrid
List of Minimum Nights which represents the day of the week, starting at Monday
Field | Data Type | Description |
Monday | Int32 | |
Tuesday | Int32 | |
Wednesday | Int32 | |
Thursday | Int32 | |
Friday | Int32 | |
Saturday | Int32 | |
Sunday | Int32 | |
Count | Int32 |
ImageIdentifiers
The image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
DerivedRatePackage
Rule for calculating derived rates for this rate package
Field | Data Type | Description |
ParentRatePackageId | Int64 | RatePackageId that the rate is derived from |
DaysFrom | Int32 | Days from today to start applying this rule |
DaysUntil | Int32 | Days after today to apply this rule |
RatePlanDerivationType | RatePlanDerivationType | Type of rate derivation |
DerivedValue | Decimal | Value used in the derivation calculation |
Rounding | Rounding | How to round the result |
RatePlanDerivationType
Type of rate derivation
Field | Data Type | Description |
PER | Percentage | |
VAL | Value | |
MAN | Manually Set |
Rounding
How to round the result
Field | Data Type | Description |
UP | Round Up | |
DOWN | Round Down | |
NEAR | Round to the closest whole | |
NONE | No 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 |
QtyRoomsAvailable | Int32 | Set 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
HotelRoomBedroom
The Bedrooms in this room and the bedding configurations of each.
Field | Data Type | Description |
BedroomId | Int64 | The unique BedroomId, set this to zero for new bedrooms |
BedroomNo | Int64 | The ordering of bedrooms, e.g 1,2 |
BedroomName | String | The name of the Bedroom e.g Master Bedroom |
Ensuite | Boolean | Whether the Bedroom has an en suite |
BedroomType | String | The name of the bedroom type for display purposes only |
RoomTypeId | Int64 | The unique room id this bedroom belongs to |
BeddingConfigurations | List of HotelRoomBeddingConfig | The list of bedding configurations this bedroom can have |
BedroomTypeCode | String | The bedroom type code |
HotelRoomBeddingConfig
The list of bedding configurations this bedroom can have
Field | Data Type | Description |
BeddingConfigId | Int64 | The unique bedding config id, set to zero for new configs |
BedroomId | Int64 | The unique bedroom id this config belongs to |
DefaultConfig | Boolean | Set to true to mark this config as the default config or setup for this room |
Beds | List of HotelRoomBeds | The list of beds within this configuration |
HotelRoomBeds
The list of beds within this configuration
Field | Data Type | Description |
BedType | String | The bed type code |
Name | String | The name of the bed type, for display purposes |
Amount | Int64 | The amount of beds supplied for this config/room |
HotelRoomBathroom
The Bathrooms in this room and the features present in each.
Field | Data Type | Description |
BathroomId | Int64 | The unique bathroom id for this bathroom, set to zero for new bathrooms |
RoomTypeId | Int64 | The unique room id that this bathroom belongs to |
BathroomTypeId | Int64 | The internal id of the bathroom type |
BathroomNumber | Int64 | The ordering of the bathrooms. |
BathroomType | String | The bathroom type code |
BathroomFeatures | List of HotelRoomBathroomFeature | The list of amenities within this bathroom |
HotelRoomBathroomFeature
The list of amenities within this bathroom
Field | Data Type | Description |
BathroomFeatureId | Int64 | The internal id of this bathroom feature type |
BathroomFeatureCode | String | The code of this bathroom feature type |
BathroomFeatureName | String | The name of this bathroom feature type |
BathroomId | Int64 | The unique bathroom id that this feature belongs to |
Amount | Int64 | The amount of this feature within this bathroom |
GetHotelVouchers
GetHotelVouchers is used to list the current vouchers for a Hotel
HotelVouchersResponse GetHotelVouchers(HotelVouchersRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | HotelVouchersRequest |
HotelVouchersRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelVouchers | List of HotelVoucher | The Hotel Voucher List |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
HotelVoucher
The Hotel Voucher List
Field | Data Type | Description |
HotelId | Int64 | The unique HotelId |
Code | String | The unique code |
Description | String | Description |
Type | HotelVoucherType | The type of hotel voucher |
Amount | Decimal | The type of hotel voucher |
Active | Boolean | Active |
AppliesToAllRatePackages | Boolean | Applies to all rate packages |
AppliesToAllRatePackageDeals | Boolean | All Rate Package Deals can be unlocked using this voucher |
RatePackages | RatePackageIds | List of Rate Package Identifiers that will have the voucher applied to them |
RatePackageDeals | RatePackageDealIds | List of Rate Package Deal Identifiers that will have the voucher applied to them |
PaymentNotRequired | Boolean | Payment is not required at booking time when using this voucher |
CurrentCode | String | The 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 |
Per | Percentage Discount | |
Val | Value Reduction |
RatePackageIds
List of Rate Package Identifiers that will have the voucher applied to them
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
RatePackageDealIds
List of Rate Package Deal Identifiers that will have the voucher applied to them
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
GetMappedChannels
get mapped distribution channels for a hotel
GetMappedChannelsResponse GetMappedChannels(GetMappedChannelsRequest request)
Method Parameters
Field | Data Type | Description |
request | GetMappedChannelsRequest |
GetMappedChannelsRequest
Field | Data Type | Description |
IncludeArchived | Boolean | Includes archived channels in response when set to true. |
IncludeMappedRates | Boolean | Flag to include mapped rate plans for each channel in the response |
DistributionChannelCode | String | Return only the mappings for this distribution channel code |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelId | Int64 | Hotel Id |
MappedDistributionChannels | List of MappedDistributionChannel | List of all mapped channels for this hotel |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
MappedDistributionChannel
List of all mapped channels for this hotel
Field | Data Type | Description |
DistributionChannelId | Int64 | The Distribution Channel Id |
ChannelName | String | The Distribution Channel Name |
ChannelCode | String | The Distribution Channel Code |
ConnectionStatus | String | The Distribution Channel connection status |
MappingId | Int64 | A Unique identifier for this mapping |
MaxAvailToPush | Int64 | When 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. |
PropertyCode | String | The OTAs or Distribution Channel unique property code |
PropertyName | String | The Property Name on the OTA or Distribution Channel |
DCRatePlans | List of DCRatePlan | A List of Rate plans and their mapping status. |
DCRatePlan
A List of Rate plans and their mapping status.
Field | Data Type | Description |
DCRatePlanId | Int64 | The Unique Mapping ID |
MappingStatus | String | Status, Active or Inactive |
MinStay | Int64 | If 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. |
RateAdjustmentPercentage | Decimal | This is set to adjust the prices sent to the OTA by this Percentage amount. No adjustment is sent if its null. |
RatePlanId | Int64 | The Actual Rate Plan ID which is setup in the GetHotelRooms message |
RemotePlanCode | String | The 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. |
RemotePlanName | String | The 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 |
APItemId | Int64 | If 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: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 |
request | GetStaticDataRequest |
GetStaticDataRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
StaticData | StaticData | The Static Data Object |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
StaticData
The Static Data Object
Field | Data Type | Description |
Countries | List of Country | The List of Countries |
Currencies | List of Currency | The List of Currencies |
HotelTypes | List of AccomType | The List of Hotel Types |
StarRatingProviders | List of CommonDefinition | The List of Star Rating Providers |
ContactPersonTitles | List of CommonDefinition | The List of Valid Titles for a Contact Person |
ContactPositions | List of CommonDefinition | The List of Valid Positions for a Contact Person |
PropertyManagementSystems | List of PropertyManagementSystem | List of Property Management Systems |
HotelTypeFeatures | List of AccomTypeFeature | List of Hotel Type Features. |
HotelTypeRoomFeatures | List of AccomTypeRoomFeature | List of Hotel Type Room Features. |
HotelDescriptions | List of CommonDefinition | A list of valid Hotel Descriptions. |
DistributionChannels | List of DistributionChannel | A list of valid Distribution Channels. |
Timezones | List of Timezone | A list of valid Timezones. |
DCCancellationPolicies | List of DistributionCancellationPolicy | A list of Distribution Channel Cancelation Policies |
DcFeeDefinitions | List of DistributionFeeDefinition | A list of Distribution Channel Fees |
BedroomTypes | List of BedroomType | A list of Bedroom Types |
BedTypes | List of BedType | A list of Bed Types |
BathroomTypes | List of BathroomType | A list of Bathroom Types |
BathroomFeatures | List of BathroomFeature | A list of Bathroom Features |
Country
The List of Countries
Field | Data Type | Description |
CountryID | Int64 | |
CountryISO | String | |
CountryISO2 | String | |
CountryName | String |
Currency
The List of Currencies
Field | Data Type | Description |
CurrencyID | Int64 | |
CurrencyISO | String | |
CurrencyName | String | |
CurrencySymbol | String | |
CurrencyAbbr | String | |
HtmlCode | String | |
NumDecimals | Int32 | |
PaymentAcceptedFlag | Boolean | |
DisplayFormat | String |
AccomType
The List of Hotel Types
Field | Data Type | Description |
AccomTypeID | Int64 | |
AccomTypeCode | String | |
AccomTypeName | String |
CommonDefinition
The List of Star Rating Providers
Field | Data Type | Description |
Code | String | A Unique Identifier code for this Common Definition |
Name | String | The Name or Description of the Common Definition |
CommonDefinition
The List of Valid Titles for a Contact Person
Field | Data Type | Description |
Code | String | A Unique Identifier code for this Common Definition |
Name | String | The Name or Description of the Common Definition |
CommonDefinition
The List of Valid Positions for a Contact Person
Field | Data Type | Description |
Code | String | A Unique Identifier code for this Common Definition |
Name | String | The Name or Description of the Common Definition |
PropertyManagementSystem
List of Property Management Systems
Field | Data Type | Description |
PMSId | Int64 | |
Name | String |
AccomTypeFeature
List of Hotel Type Features.
Field | Data Type | Description |
AccomTypeCode | String | |
FeatureTypeId | Int64 | |
FeatureTypeName | String |
AccomTypeRoomFeature
List of Hotel Type Room Features.
Field | Data Type | Description |
AccomTypeCode | String | |
FeatureTypeId | Int64 | |
FeatureTypeName | String |
CommonDefinition
A list of valid Hotel Descriptions.
Field | Data Type | Description |
Code | String | A Unique Identifier code for this Common Definition |
Name | String | The Name or Description of the Common Definition |
DistributionChannel
A list of valid Distribution Channels.
Field | Data Type | Description |
ID | Int64 | |
UniqueCode | String | |
Name | String |
Timezone
A list of valid Timezones.
Field | Data Type | Description |
Identifier | String | Identifying string for a timezone |
Name | String | Friendly name for a timezome |
UtcOffset | Decimal | Base offset from UTC (May be modified by DST) |
DistributionCancellationPolicy
A list of Distribution Channel Cancelation Policies
Field | Data Type | Description |
CancellationPolicyId | Int64 | |
DistributionChannelId | Int64 | |
DistributionChannel | String | |
PolicyCode | String | |
PolicyTitle | String | |
PolicyDescription | String |
DistributionFeeDefinition
A list of Distribution Channel Fees
Field | Data Type | Description |
FeeTypeId | Int64 | |
DistributionChannelId | Int64 | |
DistributionChannel | String | |
FeeName | String | |
FeeDescription | String | |
FeeCode | String | |
DistributionFeeSettings | List of DistributionFeeSetting |
DistributionFeeSetting
Field | Data Type | Description |
SettingTypeId | Int64 | |
FeeTypeId | Int64 | |
SettingName | String | |
SettingType | String | |
SettingCode | String | |
GroupId | Int64 | |
DistributionFeeConstraints | List of DistributionFeeConstraint |
DistributionFeeConstraint
Field | Data Type | Description |
ConstraintTypeId | Int64 | |
SettingTypeId | Int64 | |
ConstraintName | String | |
ConstraintCode | String | |
ConstraintLimit | Int64 |
BedroomType
A list of Bedroom Types
Field | Data Type | Description |
BedroomTypeId | Int64 | |
Name | String | |
Code | String |
BedType
A list of Bed Types
Field | Data Type | Description |
BedTypeId | Int64 | |
Name | String | |
Code | String |
BathroomType
A list of Bathroom Types
Field | Data Type | Description |
BathroomTypeId | Int64 | |
BathroomTypeName | String | |
BathroomTypeCode | String |
BathroomFeature
A list of Bathroom Features
Field | Data Type | Description |
BathroomFeatureTypeId | Int64 | |
BathroomFeatureName | String | |
BathroomFeatureCode | String |
RegisterForNotifications
RegisterForNotificationResponse RegisterForNotifications(RegisterForNotificationRequest request)
Method Parameters
Field | Data Type | Description |
request | RegisterForNotificationRequest |
RegisterForNotificationRequest
Field | Data Type | Description |
Register | Boolean | Set to true to register for notifications or false to deregister for notifications |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
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: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 |
request | ResetHotelCacheRequest |
ResetHotelCacheRequest
Field | Data Type | Description |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
SaveBookingQuestion
SaveBookingQuestion is used to Save a Booking Question for a Hotel.
SaveBookingQuestionResponse SaveBookingQuestion(SaveBookingQuestionRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | SaveBookingQuestionRequest |
SaveBookingQuestionRequest
Field | Data Type | Description |
BookingQuestions | List of BookingQuestion | The Booking Questions to be saved |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
BookingQuestionId | Int64 | The unique BookingQuestionId |
HotelId | Int64 | The unique HotelId |
BookingQuestionType | BookingQuestionType | The BookingQuestionType for this BookingQuestion |
Question | String | The Question of the BookingQuestion |
MandatoryResponse | Boolean | The Question required an answer from the guest, or not. |
RatePackageIds | RatePackageIds | List is rate plans that this booking questionapplies to. If none are specified then all rate plans apply. |
RoomTypeIds | RoomTypeIds | List is room types that this booking questionapplies to. If none are specified then all room types apply. |
Options | BookingQuestionOptions | The optional values to be selected for this Booking Question |
BookingQuestionType
The BookingQuestionType for this BookingQuestion
Field | Data Type | Description |
YON | Yes or No | |
TXT | Text | |
MUL | Multiple Choice | |
ALE | None (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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
RoomTypeIds
List is room types that this booking questionapplies to. If none are specified then all room types apply.
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
BookingQuestionOptions
The optional values to be selected for this Booking Question
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | String |
TimeSpan
Field | Data Type | Description |
SaveBookingQuestionResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
BookingQuestions | BookingQuestions | A List of BookingQuestions that were saved / created. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
BookingQuestions
A List of BookingQuestions that were saved / created.
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
SaveDcBookingFees
Save Dc Fees for a Booking
SaveDcBookingFeesResponse SaveDcBookingFees(SaveDcBookingFeesRequest request)
Method Parameters
Field | Data Type | Description |
request | SaveDcBookingFeesRequest |
SaveDcBookingFeesRequest
Field | Data Type | Description |
DcBookingFees | List of DcBookingFee | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
BookingId | Int64 | |
DistributionChannelId | Int64 | |
Amount | Decimal | |
FeeType | String | |
FeeName | String |
TimeSpan
Field | Data Type | Description |
SaveDcBookingFeesResponse
Field | Data Type | Description |
Success | Boolean | |
Message | String | |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
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: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 |
request | SaveHotelRequest |
SaveHotelRequest
Field | Data Type | Description |
Hotel | Hotel | The Hotel Object |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Version | Int64 | The Version number which is incremented automatically every time something relating to the Hotel has changed in the database |
HotelId | Int64 | This 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. |
Name | String | The Name of the Hotel. Minimum Length: 5 characters. Maximum Length: 100 characters. |
CountryISO | String | The Country ISO of the Country where the Hotel is located. To find a valid Country ISO call GetStaticData. |
CurrencyISO | String | The Preferred Currency that the Hotel Deals in. To find a valid Currency ISO call GetStaticData. |
Latitude | Decimal | Geo-coordinate Latitude |
Longitude | Decimal | Geo-coordinate Longitude |
LocalityId | Int64 | The Locality ID of the Suburb / Location that the hotel is closest to. |
MaxAgeChild | Int32 | The Maximum Age for a child before they will be treated as an adult in regards to calculating booking prices. |
MaxAgeInfant | Int32 | The Maximum age before a guest is considered no longer an infant. |
MinBookingHours | Decimal | The 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. |
PropertyManagementSystemCODE | String | The Property Management System code for the PMS software that the hotel uses (eg, RMS, EZYREZ, HIRUM, OPERA etc...) |
StarRating | Decimal | The Star Rating as given by the Rating Company |
StarRatingMembNum | String | The Star Rating Membership number given to the hotel by the Rating Company. Minimum Length: 1 character. Maximum Length: 20 characters. |
StarRatingType | String | The Star Rating Type Code, eg, SLF for Self Rated, AAA for AAA rated, INT for Internationally Rated, OTH for other. |
BankAccountName | String | The Name of the Hotels Bank account |
BookingFormTrackingCode | String | When the Booking form is displayed for this ap, this script or image is inserted into the page for tracking purposes. |
BankAccountNumber | String | The Bank Account number for the Hotels bank account |
BankIdentifierCode | String | An Indeitifer for the Bank Account |
BankName | String | The name of the Banking institution where the Hotels bank account is kept |
BranchName | String | The Branch for the Bank Account |
BSBNumber | String | The Bank accounts Bank State Branch Number |
BankAccountSuffix | String | The Bank Accounts Suffix |
String | An Email Address to use when contacting the Hotel for general use. | |
Fax | String | The Hotels General Fax Number |
Manager | String | The Managers name for the Hotel |
MaximumArrivalTime | String | The Maximum arrival time on a day, this is stored as 4 digits, eg, 2300 is 11pm |
MaximumDepartureTime | String | The Maximum departure time on a day, this is stored as 4 digits, eg, 1200 is 12pm |
MinimumArrivalTime | String | The minimum Arrival Time on a day, this is stored as 4 digits, eg, 1030 is 10:30 am |
MinimumDepartureTime | String | The Minimum Departure Time on a day, this is stored as 4 digits, eg, 0420 is 4:20 am |
Notes | String | Any Notes about the Hotel, this is not displayed anywhere. |
PrimaryPhoneNumber | String | The Hotels Primary Phone Number |
TaxRegistrationNumber | String | The Hotels tax Number, in Australia this is known as the ABN. |
TaxType | String | The Hotels Tax Type, eg GST = Registered for GST, INT = Input Tax Registered, N/T = Not Registered for Tax in Australia. |
BookingConfirmationText | String | When a Booking is confirmed, display this additional text on the Booking confirmation, and Confirmation Emails. |
WebsiteURL | String | The Hotels main Website URL, eg, http://www.greathotel.com.au |
QtyRooms | Int64 | The estimated Qty of Rooms that the Hotel/Property has for sale |
Addresses | List of HotelAddress | A List of Address Data for the Hotel |
Descriptions | List of HotelDescription | A List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc... |
Images | List of HotelImage | A List of Property Images |
HotelTypes | List of 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. |
HotelUsers | List of HotelUser | A List of Users that are allowed to login to the Extranet and view / modify information relating to this Hotel. |
Features | List of HotelFeature | A List of Features that describe what facilities or amenities the Hotel has |
Contacts | List of HotelContact | A List of Contacts for your Hotel. |
TimezoneIdentifier | String | The timezone of the Hotel |
HotelRegistration | HotelRegistration | Hotel Registration and Exemption Codes for properties that require them. |
HotelAddress
A List of Address Data for the Hotel
Field | Data Type | Description |
HotelAddressID | Int64 | A 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 |
AddressType | String | Type of Address, Street or Postal |
AddressLine1 | String | The Address line with the highest Priority, it is Also Mandatory |
AddressLine2 | String | 2nd Address Line if required |
AddressLine3 | String | 3rd Address Line if required |
AddressLine4 | String | 4th Address Line if required |
Suburb | String | Suburb |
City | String | City |
State | String | State as a String, eg, QLD, or Queensland |
Postcode | String | Postcode for the Address |
CountryISO | String | The Country ID |
HotelDescription
A List of Descriptions for the Hotel, example Property Descriptions, Checkin Instructions, Things To Do etc...
Field | Data Type | Description |
HotelDescriptionID | Int64 | A 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 |
DescriptionCode | String | Code for the Description, STR = Street, POS = Postal |
DescriptionName | String | Name of the Description |
Value | String | The Description Value |
HotelImage
A List of Property Images
Field | Data Type | Description |
HotelImageID | Int64 | A Unique Identifier for this Hotel Image, if you are using this object to create a new image against the hotel, specify nil or 0 |
DisplaySequence | Int64 | Use this to display the images in the order specified by the hotel |
LargeUrl | String | The URL where the Large version of the image resides. |
ThumbUrl | String | The URL where the Thumbnail version of the image resides. |
ToolTipText | String | When a mouse is hovered over the Image, display this text. |
HeroImage | Boolean | Hero Image: This image can be used as the main image on listing pages. If this element is missing, then HeroImage = false |
Width | Int64 | Width of the large version of this image. |
Height | Int64 | Height 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 |
HotelTypeID | Int64 | A Unique Identifier for this Hotel Type, if you are using this object to attach a new HotelType to the Hotel, specify nil or 0 |
HotelTypeCode | String | The 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 |
HotelUserID | Int64 | A Unique Identifier to identify the User, if you are using this object to attach a New HotelUser to the Hotel, specify nil or 0 |
FirstName | String | Users First Name |
LastName | String | Users Last Name |
EmailAddress | String | Users Email Address |
Username | String | Users Username |
Password | String | Users Password |
Role | String | Role type / or group, Eg, Administrator, Reservations, Accounts, Reception |
Mobile | String | Users Mobile Number |
HotelFeature
A List of Features that describe what facilities or amenities the Hotel has
Field | Data Type | Description |
HotelFeatureID | Int64 | A Unique Identifier to identify the Hotel Feature, if you are using this object to create a new feature, specify nil or 0 |
Name | String | The name of the Feature, this text is displayed on the Websites when promoting the Hotel |
DisplaySequence | Int64 | The 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 |
HotelContactId | Int64 | A Unique Identifier for this Hotel Contact, if you are using this object to create a new Contact against the hotel, specify nil or 0 |
Title | String | The Title of this Hotel Contact. For Example: Mr, Mrs. |
EmailAddress | String | The Hotel Contact Email Address. |
FirstName | String | The Hotel Contact First Name |
PhoneNumber | String | The Hotel Contact Contact Phone Number |
LastName | String | The Hotel Contact Surname. |
MobileNumber | String | The Hotel Contact Mobile Phone Number |
ContactPosition | String | The position of the hotel contact in your company, General Manager, Office Manager |
FaxNumber | String | The Hotel Contact Fax Number. |
HotelRegistration
Hotel Registration and Exemption Codes for properties that require them.
Field | Data Type | Description |
RegistrationNumber | String | An Optional Registration Number such as STRA Number |
RegistrationDate | DateTime | Date Registration was acquired |
RegistrationExpiry | DateTime | Registration Expiry Date |
RegistrationExemption | String | An code making the property exempt of requiring Registration (Only required if the property resides within an area requiring Registration) |
UpdateAllChannels | Boolean | Set to true to push to all OTA distribution channels |
TimeSpan
Field | Data Type | Description |
SaveHotelResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelId | Int64 | If 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 |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
SaveHotelDCFees
Save or update distribution fees
SaveHotelDCFeesResponse SaveHotelDCFees(SaveHotelDCFeesRequest request)
Method Parameters
Field | Data Type | Description |
request | SaveHotelDCFeesRequest |
SaveHotelDCFeesRequest
Field | Data Type | Description |
DistributionChannelCode | String | The code for the distribution channel. |
HotelDistributionFees | List of HotelDistributionFee | A List of DC Fee Objects |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
FeeId | Int64 | This 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. |
FeeCode | String | This is the code used to set the type of fee. This must match a fee type support by this distribution channel. |
FeeAmount | Decimal | This is the amount of the fee charged to the guest. |
HotelId | Int64 | The unique HotelID |
FeeSettings | List of HotelDistributionFeeSetting | A list of settings for a fee. |
RatePackageIds | List of Int64 | A list of rate package ids that the fee will apply to. |
HotelDistributionFeeSetting
A list of settings for a fee.
Field | Data Type | Description |
FeeId | Int64 | This is the unique identifier for your distribution fee. This Id must match the parent Id of this setting. |
SettingId | Int64 | This is the unique identifier for your Distribution Fee Setting. Set this to 0 if this is a new setting. |
SettingCode | String | The unique code of the setting |
SettingValue | String | Optional field used by some setting options |
HotelDistributionFeeRestrictions | List of HotelDistributionFeeRestriction | Option 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 |
RestrictionId | Int64 | This is the unique identifier for your distribution fee restriction. Set this to 0 if this is a new restriction. |
SettingId | Int64 | This is the unique identifier for your distribution fee setting. This Id must match the parent Id of this restriction. |
RestrictionCode | String | |
MinNumber | Decimal | |
MaxNumber | Decimal | |
MinDate | DateTime | |
MaxDate | DateTime | |
DaysOfWeek | List of Int64 | A number between 1 - 7 representing a day of the week starting at Sunday. |
TimeSpan
Field | Data Type | Description |
SaveHotelDCFeesResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
FeesAffected | List of Int64 | All Fee ids affected are returned here. If you create a new fee the ID will also be in here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
SaveHotelExtras
SaveHotelExtras is used to update or save the extras for a hotel
HotelExtrasSaveResponse SaveHotelExtras(HotelExtrasSaveRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | HotelExtrasSaveRequest |
HotelExtrasSaveRequest
Field | Data Type | Description |
HotelExtras | List of HotelExtra | The hotel rate package deals to be saved |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
HotelExtraId | Int64 | The unique HotelExtraId |
HotelId | Int64 | The unique HotelId |
HotelExtraType | HotelExtraType | The HotelExtraType for this HotelExtra |
Name | String | The Name of the HotelExtra |
Description | String | The description of the HotelExtra |
Amount | Decimal | The amount of the HotelExtra - Not required for Per Person HotelExtraType |
AdultAmount | Decimal | The adult amount of the HotelExtra - Required for Per Person HotelExtraType |
ChildAmount | Decimal | The child amount of the HotelExtra - Required for Per Person HotelExtraType |
RatePackageIds | RatePackageIds | List is rate plans that this hotel extra applies to. If none are specified then all rate plans apply. |
RoomTypeIds | RoomTypeIds | List 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 |
BOO | Per Booking | |
NGT | Per Night | |
PER | Per Person | |
QTY | Per 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
RoomTypeIds
List is room types that this hotel extra applies to. If none are specified then all room types apply.
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
TimeSpan
Field | Data Type | Description |
HotelExtrasSaveResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelExtras | HotelExtras | A List of HotelExtras that were saved / created. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
HotelExtras
A List of HotelExtras that were saved / created.
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
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 |
request | HotelRatePackageDealsSaveRequest |
HotelRatePackageDealsSaveRequest
Field | Data Type | Description |
HotelRatePackageDeals | List of HotelRatePackageDeal | The hotel rate package deals to be saved |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
HotelRatePackageDealId | Int64 | The unique HotelRatePackageDealId |
HotelRatePackageId | Int64 | The unique HotelRatePackageId |
HotelRatePackageName | String | The Name of the HotelRatePackage |
Description | String | The description of the deal eg. (Stay 7 nights pay 5 nights) |
ShortDescription | String | The description of the deal eg. (Stay 7 nights pay 5 nights) |
StartDate | DateTime | Starting Date for the deal |
EndDate | DateTime | End Date for the deal |
BookableStartDate | DateTime | First date upon which the deal may be booked |
BookableEndDate | DateTime | Last date upon which the deal may be booked |
HotelRatePackageDealType | HotelRatePackageDealType | The type of the deal |
StayNights | Int64 | The number of nights that can be stayed |
PayNights | Int64 | The number of nights that must be paid for |
Repeatable | Boolean | Is this deal repeatable? |
Discount | Decimal | Discount off the standard rate |
CloseOut | Int64 | Maximum number of days before check in this deal is available for |
CloseOutType | String | How the Closeout field should be handled, BEF = Before Arrival, AFT = after arrival. |
DatesRangesExcluded | List of DateRange | List of dates that deal does not apply to |
DaysOfWeekExcluded | List of DayOfWeek | Days of the week that this deal does not apply to |
PackageNights | Int64 | The number of nights the package rate applies for |
PackageRate | Decimal | The alternate rate for the package |
PackageRateContinues | Boolean | Does the rate for this package continue past the number of package days. Otherwise it falls back to the standard rate |
SearchRatePackageId | Int64 | Use 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 |
ValidForHotelVoucherOnly | Boolean | Is this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher? |
NoVoucherDiscountApplies | Boolean | Is this HotelRatePackageDeal only valid when used in conjunction with a HotelVoucher? |
DCMappings | List of 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. |
HotelRatePackageDealType
The type of the deal
Field | Data Type | Description |
SPY | Stay Pay | |
DIS | Percentage Discount | |
DIV | Value Discount | |
PKG | Package Deal |
DateRange
List of dates that deal does not apply to
Field | Data Type | Description |
From | DateTime | |
To | DateTime |
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 |
DCCode | String | The Distribution Channel code the mapping is for. You can get a list of possible distribution channels using the GetStaticData message. |
SourceSpecialId | String | This 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 |
Settings | List of 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. |
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 |
Key | String | The Unique key code for the setting. |
Value | String | The 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
HotelRatePackageDeals | HotelRatePackageDeals | A List of Deals that were saved / created. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
HotelRatePackageDeals
A List of Deals that were saved / created.
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
SaveHotelRentalAgreement
Save Rental Agreement for a hotel
SaveRentalAgreementResponse SaveHotelRentalAgreement(SaveRentalAgreementRequest request)
Method Parameters
Field | Data Type | Description |
request | SaveRentalAgreementRequest |
SaveRentalAgreementRequest
Field | Data Type | Description |
PdfData | String | Base64 encoded dump of the file data, eg the contents of the pdf file |
FileName | String | The Filename for this pdf, note this is not the URL but just the filename and extension. It should not contain the directory path either. |
RentalAgreementId | Int64 | The rental agreement Id of an existing rental agreement. Set this to 0 if this is a new rental agreement. |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
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 |
request | SaveHotelRoomsRequest |
SaveHotelRoomsRequest
Field | Data Type | Description |
HotelRooms | List of HotelRoom | A List of HotelRoom Objects |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Version | Int64 | |
HotelRoomId | Int64 | The unique HotelRoomId |
HotelId | Int64 | The unique HotelID |
Name | String | The name of the Hotel Room. |
Description | String | The description of the hotel room. |
BedConfiguration | String | The Bedding Configuration for the hotel room. |
LowAvailabilityQty | Int64 | The Low availability hotel room quantity. |
QtyPhysicalBedrooms | Int64 | The Qty of Bedrooms in this Room. |
QtyBathrooms | Int64 | The Qty of Bathrooms, please don't include Ensuites in this qty. |
QtyEnsuites | Int64 | The Qty of Ensuites. Please don't include ensuites in the QtyBathrooms field. |
RoomTypeFeatures | List of HotelRoomFeature | A List of Hotel Room Features. The Hotel Room Features Available for your Hotel type can be found by querying static data. |
RatePackages | List of HotelRatePackage | A List of Rate Packages or "Ways to sell this Room". |
AutoFillOptions | 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 |
Images | ImageIdentifiers | The image identifiers attached to this room. The ids can be obtained from the GetHotelDetail message |
RoomHeroImageId | Int64 | The 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. |
Bedrooms | List of HotelRoomBedroom | The Bedrooms in this room and the bedding configurations of each. |
Bathrooms | List of HotelRoomBathroom | The Bathrooms in this room and the features present in each. |
PMSRoomCode | String | The 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. |
UnitArea | Int64 | The area of the room that is available to guests. |
UnitAreaType | String | The 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 |
HotelRoomFeatureId | Int64 | The unique HotelRoomFeatureId |
FeatureTypeId | Int64 | The unique FeatureTypeId |
FeatureTypeName | String | The unique FeatureTypeName |
DisplaySeq | Int64 | The display position for the Hotel Room Feature. |
HotelRatePackage
A List of Rate Packages or "Ways to sell this Room".
Field | Data Type | Description |
Version | Int64 | |
HotelRatePackageId | Int64 | The unique HotelRatePackageId |
HotelId | Int64 | The unique id for the Hotel that this RatePackage is connected to |
Name | String | The name of the Hotel Rate Package. |
Description | String | The description of the hotel Rate Package. |
StandardGuests | Int64 | The number of guests that the price caters for, once you have more guests, there maybe extra charges which are the Extra*Charges fields. |
MaximumGuestsAllowed | Int64 | The maximum number of guests that can be included in this Rate Package. We don't count infants. |
ExtraAdultCharge | Decimal | The Charge to be applied for every adult guest that is above the StandardGuests value. |
ExtraChildCharge | Decimal | The Charge to be applied for every child guest that is above the StandardGuests value. |
RackRate | Decimal | Rack rate or Standard Rate for this Rate Package. |
AutoFillOptions | 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 |
LmDefaults | DefaultRateGenerator | An Object which specifies the Last Minute Defaults to be applied when rolling over new Dates. |
YrDefaults | DefaultRateGenerator | An Object which specifies the Year Round Defaults to be applied when rolling over new Dates. |
Images | ImageIdentifiers | The image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message |
OpenForSaleFrom | Int32 | You 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. |
OpenForSaleTo | Int32 | You 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. |
RatePlanHeroImageId | Int64 | The 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. |
RateOwner | String | The system that 'owns' the rate. Used to determine which rates can be managed by automated processes |
PMSCode | String | A 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. |
DerivedRatePackages | List of DerivedRatePackage | Rule 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 |
Rate | Decimal | Set the default Price for this RatePackage for the next 2 years to the value specified. |
MinimumNightStay | Int32 | Set the Minimum nights that a guest must stay to qualify for this Rate for the next 2 years to the value specified. |
Inclusions | String | Set 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 |
Rates | DayRateGrid | List of Prices which represents the day of the week, starting at Monday |
MinNights | DayMinNightsGrid | List of Minimum Nights which represents the day of the week, starting at Monday |
DefaultInclusion | String | One Inclusion String to be applied to all days when applying defaults. |
NumberOfDaysOut | Int32 | The Number of Days from the rollover date for the defaults to be applied. |
OverwriteExistingRates | Boolean | Set 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 |
Monday | Decimal | |
Tuesday | Decimal | |
Wednesday | Decimal | |
Thursday | Decimal | |
Friday | Decimal | |
Saturday | Decimal | |
Sunday | Decimal | |
Count | Int32 |
DayMinNightsGrid
List of Minimum Nights which represents the day of the week, starting at Monday
Field | Data Type | Description |
Monday | Int32 | |
Tuesday | Int32 | |
Wednesday | Int32 | |
Thursday | Int32 | |
Friday | Int32 | |
Saturday | Int32 | |
Sunday | Int32 | |
Count | Int32 |
DefaultRateGenerator
An Object which specifies the Year Round Defaults to be applied when rolling over new Dates.
Field | Data Type | Description |
Rates | DayRateGrid | List of Prices which represents the day of the week, starting at Monday |
MinNights | DayMinNightsGrid | List of Minimum Nights which represents the day of the week, starting at Monday |
DefaultInclusion | String | One Inclusion String to be applied to all days when applying defaults. |
NumberOfDaysOut | Int32 | The Number of Days from the rollover date for the defaults to be applied. |
OverwriteExistingRates | Boolean | Set 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 |
Monday | Decimal | |
Tuesday | Decimal | |
Wednesday | Decimal | |
Thursday | Decimal | |
Friday | Decimal | |
Saturday | Decimal | |
Sunday | Decimal | |
Count | Int32 |
DayMinNightsGrid
List of Minimum Nights which represents the day of the week, starting at Monday
Field | Data Type | Description |
Monday | Int32 | |
Tuesday | Int32 | |
Wednesday | Int32 | |
Thursday | Int32 | |
Friday | Int32 | |
Saturday | Int32 | |
Sunday | Int32 | |
Count | Int32 |
ImageIdentifiers
The image identifiers attached to this rate plan. The ids can be obtained from the GetHotelDetail message
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
DerivedRatePackage
Rule for calculating derived rates for this rate package
Field | Data Type | Description |
ParentRatePackageId | Int64 | RatePackageId that the rate is derived from |
DaysFrom | Int32 | Days from today to start applying this rule |
DaysUntil | Int32 | Days after today to apply this rule |
RatePlanDerivationType | RatePlanDerivationType | Type of rate derivation |
DerivedValue | Decimal | Value used in the derivation calculation |
Rounding | Rounding | How to round the result |
RatePlanDerivationType
Type of rate derivation
Field | Data Type | Description |
PER | Percentage | |
VAL | Value | |
MAN | Manually Set |
Rounding
How to round the result
Field | Data Type | Description |
UP | Round Up | |
DOWN | Round Down | |
NEAR | Round to the closest whole | |
NONE | No 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 |
QtyRoomsAvailable | Int32 | Set 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 |
Capacity | Int32 | |
Count | Int32 | |
Item | Int64 |
HotelRoomBedroom
The Bedrooms in this room and the bedding configurations of each.
Field | Data Type | Description |
BedroomId | Int64 | The unique BedroomId, set this to zero for new bedrooms |
BedroomNo | Int64 | The ordering of bedrooms, e.g 1,2 |
BedroomName | String | The name of the Bedroom e.g Master Bedroom |
Ensuite | Boolean | Whether the Bedroom has an en suite |
BedroomType | String | The name of the bedroom type for display purposes only |
RoomTypeId | Int64 | The unique room id this bedroom belongs to |
BeddingConfigurations | List of HotelRoomBeddingConfig | The list of bedding configurations this bedroom can have |
BedroomTypeCode | String | The bedroom type code |
HotelRoomBeddingConfig
The list of bedding configurations this bedroom can have
Field | Data Type | Description |
BeddingConfigId | Int64 | The unique bedding config id, set to zero for new configs |
BedroomId | Int64 | The unique bedroom id this config belongs to |
DefaultConfig | Boolean | Set to true to mark this config as the default config or setup for this room |
Beds | List of HotelRoomBeds | The list of beds within this configuration |
HotelRoomBeds
The list of beds within this configuration
Field | Data Type | Description |
BedType | String | The bed type code |
Name | String | The name of the bed type, for display purposes |
Amount | Int64 | The amount of beds supplied for this config/room |
HotelRoomBathroom
The Bathrooms in this room and the features present in each.
Field | Data Type | Description |
BathroomId | Int64 | The unique bathroom id for this bathroom, set to zero for new bathrooms |
RoomTypeId | Int64 | The unique room id that this bathroom belongs to |
BathroomTypeId | Int64 | The internal id of the bathroom type |
BathroomNumber | Int64 | The ordering of the bathrooms. |
BathroomType | String | The bathroom type code |
BathroomFeatures | List of HotelRoomBathroomFeature | The list of amenities within this bathroom |
HotelRoomBathroomFeature
The list of amenities within this bathroom
Field | Data Type | Description |
BathroomFeatureId | Int64 | The internal id of this bathroom feature type |
BathroomFeatureCode | String | The code of this bathroom feature type |
BathroomFeatureName | String | The name of this bathroom feature type |
BathroomId | Int64 | The unique bathroom id that this feature belongs to |
Amount | Int64 | The amount of this feature within this bathroom |
TimeSpan
Field | Data Type | Description |
SaveHotelRoomsResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
RoomsAffected | List of Int64 | All room ids affected are returned here. If you create a new room the ID will also be in here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
SaveHotelVouchers
SaveHotelVouchers is used to update or save the vouchers for a Hotel
HotelVoucherSaveResponse SaveHotelVouchers(HotelVoucherSaveRequest request)
Example
Method Parameters
Field | Data Type | Description |
request | HotelVoucherSaveRequest |
HotelVoucherSaveRequest
Field | Data Type | Description |
HotelVouchers | List of HotelVoucher | The hotel vouchers deals to be saved |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
HotelId | Int64 | The unique HotelId |
Code | String | The unique code |
Description | String | Description |
Type | HotelVoucherType | The type of hotel voucher |
Amount | Decimal | The type of hotel voucher |
Active | Boolean | Active |
AppliesToAllRatePackages | Boolean | Applies to all rate packages |
AppliesToAllRatePackageDeals | Boolean | All Rate Package Deals can be unlocked using this voucher |
RatePackages | RatePackageIds | List of Rate Package Identifiers that will have the voucher applied to them |
RatePackageDeals | RatePackageDealIds | List of Rate Package Deal Identifiers that will have the voucher applied to them |
PaymentNotRequired | Boolean | Payment is not required at booking time when using this voucher |
CurrentCode | String | The 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 |
Per | Percentage Discount | |
Val | Value Reduction |
RatePackageIds
List of Rate Package Identifiers that will have the voucher applied to them
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
RatePackageDealIds
List of Rate Package Deal Identifiers that will have the voucher applied to them
Field | Data Type | Description |
Capacity | Int32 | |
Count | Int32 | |
Item | Int32 |
TimeSpan
Field | Data Type | Description |
HotelVoucherSaveResponse
Field | Data Type | Description |
Success | Boolean | Indicates if the operation was successful or not. |
ErrorCode | String | If there was an error, the error code is returned here. |
Message | String | Success and Error Information is returned here. |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |
SaveOtaCancellationPolicy
SaveOtaCancellationPolicyResponse SaveOtaCancellationPolicy(SaveOtaCancellationPolicyRequest request)
Method Parameters
Field | Data Type | Description |
request | SaveOtaCancellationPolicyRequest |
SaveOtaCancellationPolicyRequest
Field | Data Type | Description |
ChannelCode | String | |
PolicyCode | String | |
ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
Username | String | Hotels 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 |
Password | String | Hotels 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 |
HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
HotelAuthenticationKey | String | Authentication 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 |
Success | Boolean | |
Message | String | |
Timestamp | DateTime | |
MessageId | String | |
HotelAuthenticationKey | String |