Types operations

The types operations retrieve the different master lists needed to use with the ContentAPI responses.

Request Parameters

There are several operations, all of which have the following common request parameters:

Parameter Type Description
fields String The list of fields to be received in the response. If nothing is specified, the accommodation type code is returned. To retrieve all the fields use ‘all’. See the complete list of available fields in the response.
lastUpdateTime String Specifying this parameter limits the results to those modified or added after the date specified. The required format is YYYY-MM-DD.
language String The language code for the language in which you want the descriptions to be returned. If the language is not specified, English is the default language.
from String The number of the initial record to receive. If nothing is specified, 1 is the default value.
to String The number of the final record to receive. If nothing is indicated, 100 is the default value.
useSecondaryLanguage String Specify "True" if you want to receive the descriptions in English if the description is not available in the language requested. Specify "False" (default value) if you do not want to receive the description in English if the language requested is not available.

 

/types/accommodations

Returns the list of accommodation types (apartment, hotel, home,...)

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/accommodations

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/accommodations?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/accommodations?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
accommodations Array of accommodation types Occurrences 0..1 No Key Top Level
accommodations/accommodation accommodation element Occurrences 0..* No Key Top Level
accommodations/accommodation/@code String 8 Key Hotel Type Code it will indicate the type of establishment (apartment, hotel, home)
accommodations/accommodation/@typeDescription String 30 No Key Internal Hotel Type Description
accommodations/accommodation/typeMultiDescription Element Occurrences 1 No Key Hotel Type description and language
accommodations/accommodation/typeMultiDescription/@languageCode String 3 No Key Language in which the content is returned
accommodations/accommodation/typeMultiDescription/@content String 30 No Key Multilanguage Hotel Type Description
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<accommodationsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from></from>
	<to></to>
	<total></total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<accommodations>
		<accommodation code="" typeDescription="">
			<typeMultiDescription languageCode=""></typeMultiDescription>
		</accommodation>
	</accommodations>
</accommodationsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"accommodations": [{
		"code": "",
		"typeDescription": "",
		"typeMultiDescription": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/boards

Returns the list of meal plan types (bed and breakfast, half board, full board, all inclusive,...)

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/boards

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/boards?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/boards?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
boards Array of hotel board types Occurrences 0..1 No Key Top Level
boards/board Board element Occurrences 0..* No Key Top Level
boards/board/@code String 8 Key Board Type Code that will indicate the meal plans available at the hotel (bed and breakfast, half board, all inclusive,...)
boards/board/description Element Occurrences 1 No Key Internal board description and language
boards/board/description/@content String 30 No Key Internal Board Type Description
boards/board/@multiLingualCode String 30 No Key Multilanguage Board Description
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<boardsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<boards>
		<board code="">
			<description></description>
			<multiLingualCode></multiLingualCode>
		</board>
	</boards>
</boardsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"boards": [{
		"code": "",
		"description": {
			"content": ""
		},
		"multiLingualCode": ""
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/categories

Returns the list of categories.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/categories

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/categories?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/categories?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
categories Array of hotel categories Occurrences 0..1 No Key Top Level
categories/category Hotel category element Occurrences 0..* No Key Top Level
categories/category/@code String 5 Key Hotel star rating based on the information provided by the hotel
categories/category/@simpleCode String 5 Key Simple category code used for filtering in Hotel BookingAPI availability
categories/category/@accommodationType String 8 Key Hotel Type Code it will indicate the type of establishment (apartment, hotel, home)
categories/category/@group String 5 Key Group of Category that the category belongs to
categories/category/description Element Occurrences 1 No Key Category description and language
categories/category/description/@languageCode String 3 No Key Language in which the content is returned
categories/category/description/@content String 30 No Key Description of the category
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<categoriesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<categories>
		<category code="" simpleCode="" accommodationType="" group="">
			<description></description>
		</category>
	</categories>
</categoriesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"categories": [{
		"code": "",
		"simpleCode": "",
		"accommodationType": "",
		"group": "",
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/chains

Returns the list of chains/brands.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/chains

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/chains?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/chains?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
chains Array of hotel chains Occurrences 0..1 No Key Top Level
chains/chain Hotel chain element Occurrences 0..* No Key Top Level
chains/chain/@code String 5 Key Code of the chain that the hotel belongs to
chains/chain/description Element Occurrences 1 No Key Chain description and language
chains/chain/description/@languageCode String 3 No Key Language in which the content is returned
chains/chain/description/@content String 30 No Key Description of the chain
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<chainsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<chains>
		<chain code="">
			<description></description>
		</chain>
	</chains>
</chainsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"chains": [{
		"code": "",
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/currencies

Returns the list of currencies (Dollar, Euro,...)

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/currencies

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/currencies?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/currencies?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
currencies Array of currencies Occurrences 0..1 No Key Top Level
currencies/currency Currency element Occurrences 0..* No Key Top Level
currencies/currency/@code String 5 Key Internal currency code
currencies/currency/description Element Occurrences 1 No Key Currency description and language
currencies/currency/description/@languageCode String 3 No Key Language in which the content is returned
currencies/currency/description/@content String 50 No Key Description of the currency
currencies/currency/@currencyType String Only values "LIBERATE", "BOTH" No Key Indication for which rate type will be returned.
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<currenciesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<currencies>
		<currency code="" currencyType="">
			<description></description>
		</currency>
	</currencies>
</currenciesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"currencies": [{
		"code": "",
		"description": {
			"languageCode": "",
			"content": ""
		},
		"currencyType": ""
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/facilities

Returns the list of facilities and features (Pool, parking,...)

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilities

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilities?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilities?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
facilities Array of facilities Occurrences 0..1 No Key Top Level
facilities/facility Facility element Occurrences 0..* No Key Top Level
facilities/facility@code Integer 3 Key Code of the facility
facilities/facility@facilityGroupCode Integer 3 Key Group the facility belongs to
facilities/facility@facilityTypologyCode Integer 3 Key Typology of the facility which determines the fields to recieve in the hotels operation
facilities/facility/description Element Occurrences 1 No Key Facility description and language
facilities/facility/description/@languageCode String 3 No Key Language in which the content is returned
facilities/facilitydescription/@content String 100 No Key Description of the facility
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<facilitiesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<facilities>
		<facility code="" facilityGroupCode="" facilityTypologyCode="">
			<description></description>
		</facility>
	</facilities>
</facilitiesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"facilities": [{
		"code": 0,
		"facilityGroupCode": 0,
		"facilityTypologyCode": 0,
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/facilitygroups

Returns the list of groups of facilities and features.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilitygroups

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilitygroups?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilitygroups?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
facilityGroups Array of facility groups Occurrences 0..1 No Key Top Level
facilityGroups/group Facility group element Occurrences 0..* No Key Top Level
facilityGroups/group/@code Integer 3 Key Group the facility belongs to
facilityGroups/group/description Element Occurrences 1 No Key Facility group description and language
facilityGroups/group/description/@languageCode String 3 No Key Language in which the content is returned
facilityGroups/group/description/@content String 100 No Key Description of the facility group
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<facilityGroupsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<facilityGroups>
		<group code="">
			<description></description>
		</group>
	</facilityGroups>
</facilityGroupsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"facilityGroups": [{
		"code": 0,
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/facilitytypologies

Returns the list of facility typologies (Classification of facility, indicating which fields will be returned in the response)

Remarks: Since all fields are returned by default, there won't be any field to filter.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilitytypologies

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilitytypologies?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/facilitytypologies?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
facilityTypologies Array of facility typologies Occurrences 0..1 No Key Top Level
facilityTypologies/facilityTypology Facility typologiy element Occurrences 0..* No Key Top Level
facilityTypologies/facilityTypology/@code Integer 3 Key Typology code that the facility belongs to.
facilityTypologies/facilityTypology/@numberFlag Boolean No Key Indicator if the Number Value will be returned
facilityTypologies/facilityTypology/@logicFlag Boolean No Key Indicator if the Logic Value will be returned
facilityTypologies/facilityTypology/@feeFlag Boolean No Key Indicator if the Fee Value will be returned
facilityTypologies/facilityTypology/@distanceFlag Boolean No Key Indicator if the distance Value will be returned
facilityTypologies/facilityTypology/@ageFromFlag Boolean No Key Indicator if the ageFrom Value will be returned
facilityTypologies/facilityTypology/@ageToFlag Boolean No Key Indicator if the ageTo Value will be returned
facilityTypologies/facilityTypology/@dateFromFlag Boolean No Key Indicator if the dateFrom Value will be returned
facilityTypologies/facilityTypology/@dateToFlag Boolean No Key Indicator if the dateTo Value will be returned
facilityTypologies/facilityTypology/@timeFromFlag Boolean No Key Indicator if the timeFrom Value will be returned
facilityTypologies/facilityTypology/@timeToFlag Boolean No Key Indicator if the timeTo Value will be returned
facilityTypologies/facilityTypology/@indYesOrNoFlag Boolean No Key Indicator if the YesOrNo Value will be returned
facilityTypologies/facilityTypology/@amountFlag Boolean No Key Indicator if the amount Value will be returned
facilityTypologies/facilityTypology/@currencyFlag Boolean No Key Indicator if the currency Value will be returned
facilityTypologies/facilityTypology/@appTypeFlag Boolean No Key Indicator if the appType Value will be returned
facilityTypologies/facilityTypology/@textFlag Boolean No Key Indicator if the Text Value will be returned
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<facilityTypologiesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from></from>
	<to></to>
	<total></total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<facilityTypologies>
		<facilityTypology 
			code="" 
			textFlag="false" 
			numberFlag="true" 
			logicFlag="false" 
			feeFlag="false" 
			distanceFlag="false" 
			ageFromFlag="false" 
			ageToFlag="false" 
			dateFromFlag="false" 
			dateToFlag="false" 
			timeFromFlag="false" 
			timeToFlag="false" 
			indYesOrNoFlag="false" 
			amountFlag="false" 
			currencyFlag="false" 
			applicationTypeFlag="false"/>
	</facilityTypologies>
</facilityTypologiesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"facilityTypologies": [{
		"code": 0,
		"numberFlag": false,
		"logicFlag": false,
		"feeFlag": false,
		"distanceFlag": false,
		"ageFromFlag": false,
		"ageToFlag": false,
		"textValueFlag": false,
		"dateFromFlag": false,
		"dateToFlag": false,
		"timeFromFlag": false,
		"timeToFlag": false,
		"indYesOrNoFlag": false,
		"amountFlag": false,
		"currencyFlag": false,
		"appTypeFlag": false,
		"textFlag": false	
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/issues

Returns the list of issues (Repair works, facilities closed,...)

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/issues

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/issues?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/issues?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
issues Issue element Occurrences 0..* No Key Top Level
issues/@type String 25 Key Type code of the incidence
issues/@code String 50 Key Code for the issue
issues/@alternative Boolean No Key Indicator if there will be an alternative due to the issue
issues/name Element Occurrences 1 No Key Name and Language of the issue
issues/name/@languageCode String 3 No Key Language in which the content is returned
issues/name/@content String 300 No Key Name of the issue
issues/description Element Occurrences 1 No Key Issue description and language
issues/description/@languageCode String 3 No Key Language in which the content is returned
issues/description/@content String 300 No Key Full description of the issue
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<issuesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" r
		elease=""/>
	<issues code="" type="" alternative="">
		<description></description>
		<name></name>
	</issues>
</issuesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"issues": [{
		"type": "",
		"code": "",
		"alternative": false,
		"name": {
			"languageCode": "",
			"content": ""
		},
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/languages

Returns the list of available languages.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/languages

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/languages?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/languages?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
languages Array of languages Occurrences 0..1 No Key Top Level
languages/language Language element Occurrences 0..* No Key Top Level
languages/language/@code String 3 Key Internal Language code
languages/language/@name String 10 No Key Internal language description
languages/language/description Element Occurrences 1 No Key Languace description
languages/language/description/@languageCode String 3 No Key Language in which the content is returned
languages/language/description/@content String 2000 No Key Description of the language
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<languagesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<languages>
		<language code="" name="">
			<description></description>
		</language>		
	</languages>
</languagesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"languages": [{
		"code": "",
		"name": "",
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/promotions

Returns the list of promotions and offers that can be applied to the hotels rates.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/promotions

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/promotions?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/promotions?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
promotions Array of promotions Occurrences 0..1 No Key Top Level
promotions/promotion Promotion element Occurrences 0..* No Key Top Level
promotions/promotion/@code String 10 Key Internal Promotion code
promotions/promotion/name Element Occurrences 1 No Key Promotion name and language
promotions/promotion/name/@languageCode String 3 No Key Language in which the content is returned
promotions/promotion/name/@content String 100 No Key Internal Promotion Name
promotions/promotion/description Element Occurrences 0..1 No Key Promotion description and language
promotions/promotion/description/@languageCode String 3 No Key Language in which the content is returned
promotions/promotion/description/@content String 2000 No Key Description of the promotion
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<promotionsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<promotions>
		<promotion code="">
			<description></description>
			<name></name>
		</promotion>
	</promotions>
</promotionsRS>

JSON schema

		{
			"auditData": {
				"processTime": "",
				"timestamp": "",
				"requestHost": "",
				"serverId": "",
				"environment": "",
				"release": ""
			},
			"promotions": [{
				"code": "",
				"name": {
					"languageCode": "",
					"content": ""
				},
				"description": {
					"languageCode": "",
					"content": ""
				}
			}],
			"from": 0,
			"to": 0,
			"total": 0
		}
			

 

/types/rooms

Returns the list of room types.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/rooms

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/rooms?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/rooms?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
rooms Array of rooms Occurrences 0..1 No Key Top Level
rooms/room Room element Occurrences 0..* No Key Top Level
rooms/room/@code String

For unified clients "Room type code.Characteristics": 18

For non Unified clients "Room type code–Company code": 7

Key Identifier of the room type
rooms/room/@type String 3 No Key Internal Room type code, returned only for Unified clients.
rooms/room/@characteristic String 15 Key for non Unified clients, No Key for Unified clients Characteristic code/s of the room
rooms/room/@minPax Integer 3 No Key Minimum number of paxes allowed in the room
rooms/room/@maxPax Integer 3 No Key Maximum number of paxes allowed in the room
rooms/room/@maxAdults Integer 3 No Key Maximum number of adults allowed in the room
rooms/room/@maxChildren Integer 3 No Key Maximum number of children allowed in the room
rooms/room/@minAdults Integer 3 No Key Minimum number of adults allowed in the room
rooms/room/@description String Room type description: 50, Room characteristic description: 50 No Key Internal description for the room
rooms/room/typeDescription Element Occurrences 0..1 No Key Description and language of the room type
rooms/room/typeDescription/@languageCode String 3 No Key Language in which the content is returned
rooms/room/typeDescription/@content String 50 No Key Multilanguage description of the room type
rooms/room/characteristicdescription Element Occurrences 0..1 No Key Characteristic description and language
rooms/room/characteristicdescription/@languageCode String 3 No Key Language in which the content is returned
rooms/room/characteristicdescription/@content String 50 No Key Description of the room characteristic
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

		<?xml version="1.0" encoding="UTF-8"?>
		<roomsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
			<from>0</from>
			<to>0</to>
			<total>0</total>
			<auditData 
				processTime="" 
				timestamp="" 
				requestHost="" 
				serverId="" 
				environment="" 
				release=""/>
			<rooms>
				<room 
					code="" 
					characteristic="" 
					minPax="" 
					maxPax="" 
					maxAdults="" 
					maxChildren="" 
					minAdults="" 
					description="">
					<typeDescription></typeDescription>
					<characteristicDescription></characteristicDescription>
				</room>
			</rooms>
		</roomsRS>
			

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"rooms": [{
		"code": "",
		"type": "",
		"characteristic": "",
		"minPax": 0,
		"maxPax": 0,
		"maxAdults": 0,
		"maxChildren": 0,
		"minAdults": 0,
		"description": "",
		"typeDescription": {
			"languageCode": "",
			"content": ""
		},
		"characteristicDescription": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/segments

Returns the list of segments that are used to define hotels.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/segments

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/segments?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/segments?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
segments Array of segments Occurrences 0..1 No Key Top Level
segments/segment Segments element Occurrences 0..* No Key Top Level
segments/segment/@code Integer 3 Key Code of the segment
segments/segment/description Element Occurrences 0..1 No Key Segment description and language
segments/segment/description/@languageCode String 3 No Key Language in which the content is returned
segments/segment/description/@content String 100 No Key Description of the segment
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<segmentsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<segments>
		<segment code="">
			<description></description>
		</segment>
	</segments>
</segmentsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"segments": [{
		"code": "",
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/terminals

Returns the list of terminals per country/destination.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/terminals

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/terminals?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/terminals?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
terminals Array of terminals Occurrences 0..1 No Key Top Level
terminals/terminal Terminal element Occurrences 0..* No Key Top Level
terminals/terminal/@country String 3 No Key Internal Country Code
terminals/terminal/@code String 5 Key Terminal code
terminals/terminal/name Element Occurrences 0..1 No Key Name and language of the terminal
terminals/terminal/name/@languageCode String 3 No Key Language in which the content is returned
terminals/terminal/name/@content String 50 No Key Name of the terminal
terminals/terminal/@type String 1 No Key Code of the type of terminal
terminals/terminal/description Element Occurrences 0..1 No Key Terminal type description and language
terminals/terminal/description/@languageCode String 3 No Key Language in which the content is returned
terminals/terminal/description/@content String 50 No Key Description of the type of terminal
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<terminalsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<terminals>
		<terminal code="" type="" country="">
			<name></name>
			<description></description>
		</terminal>
	</terminals>
</terminalsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"terminals": [{
		"country": "",
		"code": "",
		"name": {
			"languageCode": "",
			"content": ""
		}"type": "",
		"description": {
			"languageCode": "",
			"content": "" 
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/imagetypes

Returns the list of descriptions of the different image types.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/imagetypes

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/imagetypes?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/imagetypes?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
imageTypes Array of image types Occurrences 0..1 No Key Top Level
imageTypes/imageType imageType element Occurrences 0..* No Key Top Level
imageTypes/imageType/@code String 5 Key Internal Image Type code
imageTypes/imageType/description Element Occurrences 0..1 No Key Image type description and language
imageTypes/imageType/description/@languageCode String 3 No Key Language in which the content is returned
imageTypes/imageType/description/@content String 50 No Key Description of the type of image
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<imageTypesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<imageTypes>
		<imageType code="">
			<description></description>
		</imageType>
	</imageTypes>
</imageTypesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"imageTypes": [{
		"code": "",
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/groupcategories

Returns the list of descriptions of the different category groups.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/groupcategories

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/groupcategories?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/groupcategories?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
groupCategories Array of groupCategories Occurrences 0..1 No Key Top Level
groupCategories/groupCategory Group category element Occurrences 0..* No Key Top Level
groupCategories/groupCategory/@code String 5 Key Internal Category Group code
groupCategories/groupCategory/@order Integer 2 Key Internal order of the category group
groupCategories/groupCategory/description Element Occurrences 0..1 No Key Category Group description and language
groupCategories/groupCategory/description/@languageCode String 3 No Key Language in which the content is returned
groupCategories/groupCategory/description/@content String 50 No Key Description of the category group
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<groupCategoriesRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<groupCategories>
		<groupCategory code="" order="">
			<name></name>
			<description></description>
		</groupCategory>
	</groupCategories>
</groupCategoriesRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"groupCategories": [{
		"code": "",
		"order": 0,
		"description": {
			"languageCode": "",
			"content": ""
		}
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/ratecomments

Returns the descriptions of the Rate Comments associated with the hotel that the hotelier wants the final passenger to read before confirming the booking. You can check the use of Rate Comments here.

In addition to the common /types/ operation parameters on the top, it has an additional parameter.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/ratecomments

Request parameters

Parameter Type Mandatory Description
code String N Rate comment code

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/ratecomments?fields=all&language=ENG&from=1&to=100

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/ratecomments?lastUpdateTime=2018-06-01&fields=all&language=ENG

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
rateComments Array of rateComments Occurrences 0..1 No Key Top Level
rateComments/rateComment rateComment element Occurrences 0..* No Key Top Level
rateComments/rateComment/@incoming String 5 Key Code of the incoming office of the hotel
rateComments/rateComment/@hotel Integer 8 No Key Internal Hotel Code
rateComments/rateComment/@code String 8 Key Internal code of the comment of the hotel
rateComments/rateComment/commentsByRates Element Occurrences 0..1 Key List of tariffs and rate comments
rateComments/rateComment/commentsByRates/@rateCodes String Occurrences 1 Key List of tariffs for which the rate comment is applied, separated by spaces
rateComments/rateComment/commentsByRates/comments Element Occurrences 0..1 Key List of rate comments
rateComments/rateComment/commentsByRates/comments/@dateStart String 12 Key Date in which the comment start to apply
rateComments/rateComment/commentsByRates/comments/@dateEnd String 12 Key Date in which the comment ends
rateComments/rateComment/commentsByRates/comments/description Element Occurrences 0..1 No Key Rate comments description and language
rateComments/rateComment/commentsByRates/comments/description/@languageCode String 3 No Key Language in which the content is returned
rateComments/rateComment/commentsByRates/comments/description/@content String 50 No Key Description of the rate comments
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<rateCommentsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance">
	<from>0</from>
	<to>0</to>
	<total>0</total>
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<rateComments>
		<rateComment incoming="" hotel="" code="">
			<commentsByRates>
				<commentByRates rateCodes="">
					<comments dateEnd="" dateStart="">
						<description></description>
					</comments>
				</commentByRates>
			</commentsByRates>
		</rateComment>
	</rateComments>
</rateCommentsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"rateComments": [{
		"incoming": "",
		"hotel": 0,
		"code": 0,
		"commentsByRates": [{
			"rateCodes": [0],
			"comments": [{
				"dateStart": "",
				"dateEnd": "",
				"description": {
					"languageCode": "",
					"content": ""
				}
			}]
		}]
	}],
	"from": 0,
	"to": 0,
	"total": 0
}

 

/types/ratecommentdetails

Returns the descriptions of the rate comments associated with the hotel that the hotelier wants the client to read before confirming the booking with the given date. You can check the use of Rate Comments here.

In addition to the common /types/ operation parameters on the top, it has two additional parameters.

Request

Endpoint

GET https://api.test.hotelbeds.com/hotel-content-api/1.0/types/ratecommentdetails

Request parameters

Paramenter Type Mandatory Description
code String Y Rate comment code
date Date Y Check in date. Format: YYYY-MM-DD

Request examples

https://api.test.hotelbeds.com/hotel-content-api/1.0/types/ratecommentdetails?code=79|51538|0&fields=all&date=2016-03-18&language=CAS&from=1&to=100

 

Response

Response parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
@date String 12 Key Date of the application of the rate
@incoming String 5 Key Code of the incoming office of the hotel
@hotel Integer 8 No Key Internal Hotel Code
@code String 8 Key Internal code of the comment of the hotel
rateComments Array of rateCommentsDetails Occurrences 0..1 No Key Top Level
rateComments/rateComment rateComments detail element Occurrences 0..* No Key Top Level
rateComments/rateComment/@dateStart String 12 Key Date in which the comment start to apply
rateComments/rateComment/@dateEnd String 12 Key Date in which the comment ends
rateComments/rateComment/description String 50 No Key Description of the rate comments

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<rateCommentDetailsRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLschema-instance" date="" incoming="" code="" hotel="">
	<auditData 
		processTime="" 
		timestamp="" 
		requestHost="" 
		serverId="" 
		environment="" 
		release=""/>
	<rateComments>
		<rateComment dateEnd="" dateStart="">
			<description></description>
		</rateComment>
	</rateComments>
</rateCommentDetailsRS>

JSON schema

{
	"auditData": {
		"processTime": "",
		"timestamp": "",
		"requestHost": "",
		"serverId": "",
		"environment": "",
		"release": ""
	},
	"date": "0",
	"incoming": 0,
	"hotel": 0,
	"rateComments": [{
		"dateEnd": "",
		"dateStart": "",
		"description": ""
	}],
	"code": ""
}

Docs Navigation