IDS Hotel Descriptive Info

Element Name Attribute Name

Mandatory (M)

Optional (O)

Data Type

“Sample Value” Usage

OTA_HotelDescriptiveInfoRQ

EchoToken

O

String (128)

A reference for message identification assigned by the requesting host

system.

TimeStamp

M

Datetime

Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601:

YYYYMMDDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2009, 1:59:38 pm UTC becomes 20091120T13:59:38Z).

Version

M

Decimal

“1.00”

SequenceNmbr

M

Integer

Used to identify the sequence number of the transaction as assigned by the sending system; allows for an application to process messages in a certain order or to request a resynchronization of messages in the event that a system has been off-line and needs to retrieve messages that were missed.

HotelDescriptiveInfos

M

Each segment includes a collection of criteria that requests a property.

HotelDescriptiveInfo

M

Only one HotelDescriptiveInfo per message is supported.

HotelCode

M

string

The CRS code that uniquely identifies a single hotel property. The cross- reference table that translates the chain ID of one system into the chain ID of another system must currently be maintained in the source booking channel. Length 1 to 16.

ChainCode

M

String (2)

The CRS code that identifies a hotel chain or management group. The cross-reference table that translates the chain ID of one system into the chain ID of another system must currently be maintained in the source booking channel. Length 1 to 8.

Level

Occurrence

Type

Element Name/Attribute Name

Mandatory (M)

Optional (O)

Data Type

“Sample Value” Usage

0

1

E

OTA_HotelDescriptiveInfoRS

A

Success

O

The presence of the empty Success element explicitly indicates that the OTA versioned message succeeded.

A

Warnings

O

The presence of the empty Success element explicitly indicates that the OTA versioned message succeeded.

A

Warning

O

Standard way to indicate successful processing of an OTA message, but one in which warnings are generated

1

1

E

HotelDescriptiveContents

M

A collection of hotel descriptive contents

A

Chain Code

M

String

Hotel brand chain code

A

HotelCode

M

String

The CRS code that uniquely identifies a single hotel property.

A

HotelName

M

String

Hotel name

2

1

E

HotelDescriptiveContent

O

Hotel Descriptive content

A

CurrencyCode

M

String(3)

The 3-character alpha code specifying a monetary unit based on ISO 4217.

A

LanguageCode

M

String(3)

Identification of the requested language to be used for the hotel descriptive information. ISO standard for human-readable languages. If no Language Code is specified, the default response will be English, regardless of the hotel’s default language.

A

UnitOfMeasure

M

String

The unit of measure in a code format. Refer to OTA Code List Unit of Measure Code (UOM).

A

TimeZone

M

String

Describes the local time zone in which the hotel is located. This could include additional information regarding time zones (e.g., Daylight Saving Time observed), a proprietary code, the difference between the local time and GMT.

A

ChainCode

O

String

Hotel brand chain code

A

ChainName

O

string

Hotel brand chain name

3

1

E

HotelInfo

M

Hotel descriptive info

A

WhenBuilt

O

Integer

The year hotel was built

A

HotelStatus

M

String

This is a description of the operating status of the Hotel.

4

E

HotelStatusCode

M

String

This indicates the operating status (e.g. Open, Closed, Deflagged, Pre-opening) of the hotels to be returned in the response. Refer to OTA Code List HotelStatusCode.

4

E

CategoryCodes

M

String

Collection of descriptive details about a hotel.

A

HotelName

M

Hotel name

4

E

LocationCategory

O

Defines the general location of the hotel such as airport, suburban, downtown.

A

Code

O

String

This defines the location of the hotel (e.g. downtown, airport or suburban, etc.). Refer to OTA Code List Location Category Codes (LOC).

A

CodeDetail

O

String

Give further detail on the code.

4

1

E

SegmentCategory

O

String

Defines the type of hotel such as luxury, extended stay, and economy. Refer to OTA Code List Segment Category Code (SEG).

4

1

E

HotelCategory

O

String

Defines the particular type of hotel (e.g., golf, ski, bed and breakfast).

4

1

E

GuestRoomInfo

M

The types and quantities of guest rooms at a hotel.

A

Code

M

String

Refer to OTA Code List Guest Room Info (GRI).

A

CodeDetail

O

String

Further detail on the code.

A

Quantity

M

String

Total number of rooms

4

1

E

Position

O

Describes the geocoded location of the hotel.

A

Latitude

O

String

The measure of the angular distance on a meridian north or south of the equator.

A

Longitude

O

String

The measure of the angular distance on a meridian east or west of the prime meridian.

4

1

E

Services

M

Collection of hotel services and/or amenities available to the guest.

5

1..n

E

Service

O

A hotel service or amenity available to the guest such as a business center, concierge, valet parking, massage, newspapers, etc.

A

Code

M

String

OTA Code List Hotel Amenity Code (HAC).

A

ExistsCode

M

String

This attribute is used to explicitly define whether an amenity or service is free.

A

CodeDetail

M

String

Detail of the amenity

A

ProximityCode

O

String

Denotes whether a service is onsite, offsite or information is not available.

6

1

E

DescriptiveText

O

String

Descriptive text that describes the service.

3

1

E

FacilityInfo

M

Describes the facilities provided at the hotel, including meeting rooms restaurants.

4

1

E

GuestRooms

M

Collection of guest room types that are comprised within the hotel.

5

1..n

E

GuestRoom

The accommodation occupied by a guest.

A

RoomTypeName

M

String

The room type name

A

MaxOccupancy

M

Integer

Maximum number of guests allowed in a room type.

A

MaxAdultOccupancy

M

Integer

Maximum number of adults allowed in a room type.

A

MaxChildOccupancy

M

Integer

Maximum number of children allowed in a room type.

6

1

E

TypeRoom

Describes the guest room type; in composite types there can be multiple occurrences.

A

StandardNumBeds

M

Integer

Indicates the usual number of beds for this room type.

A

StandardOccupancy

M

Interger

Indicates the usual number of guests that occupy this room.

A

Size

O

Decimal

Number of square units (feet or meters) that defines the size of a room type.

A

Name

M

String

Text name of the type of room such as "Two Bedroom Villas".

A

RoomTypeCode

M

String

Specific system room type code, ex: A1K, A1Q etc.

6

0..n

E

MultimediaDescriptions

O

Multimedia information about the guest room.

0..n

E

MultimediaDescription

O

A multimedia item.

0..n

E

ImageItems

O

Collection of image items.

0..n

E

ImageItem

O

Image of a given category.

0..n

E

ImageFormat

O

A set of images for a given category which may be provided in multiple formats.

A

Width

O

Integer(2)

The width of the image item (unit specified by unit of measure).

A

Height

O

Integer(2)

The height of the image item (unit specified by unit of measure).

A

Format

O

Codes

Identifies the format of an image. Refer to OTA Code List Content Format Code (CFC).

URL

O

String

URL of the multimedia item for a specific format.

4

1

E

Policies

M

A collection of policy information as it applies to the hotel.

5

1..n

E

Policy

M

Describes the policies of the hotel, such as the type of payments, or whether children or pets are accepted.

6

1

E

CancelPolicy

M

Defines the cancellation policy of the hotel facility. A collection of CancelPenalty.

A

CancelPolicyIndicator

M

Bool

When true, indicates a cancel policy exits. When false, no cancel policy exists. Typically this indicator is used when details are not being sent.

7

1

E

CancelPenalty

Defines the cancellation penalty of the hotel facility.

8

1

E

Deadline

Cancellation deadline, absolute or relative.

A

AbsoluteDeadline

M

Datetime

Defines the absolute deadline.

A

OffsetDropTime

M

Codes

An enumerated type indicating when the deadline drop time goes into effect.

AfterArrival: The deadline applies after the scheduled arrival time.

AfterDeparture: The deadline applies after the scheduled departure time.

BeforeArrival: The deadline applies befpr the scheduled arrival time.

E

AmountPercent

M

Cancellation fee expressed as a fixed amount, or percentage of/or room nights.Defines the percentage basis for calculating the fee amount or the amount

A

NmbrOfNights

O

Integer(2)

The number of nights of the hotel stay that are used to calculate the fee amount.

A

Percent

O

Decimal

The percentage used to calculate the amount.

8

1

E

PenaltyDescription

O

Text description of the Penalty in a given language. An indication of a new paragraph for a sub-section of a formatted text message.

A

Text

O

String

Indicates the format of text used in the description e.g. unformatted or html.

6

1

E

GuaranteePaymentPolicy

M

A collection of deposit policies, guarantees policy, and/or accepted forms of payment.

7

1

E

GuaranteePayment

M

Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.

A

PaymentCode

M

Codes

This defines the form of payment.

A

GuaranteeCode

M

Codes

Guarantee Code

A

GuaranteeType

M

Codes

Defines the guarantee to be applied to this reservation.

A

Start

M

Datetime

The starting value of the time span.

A

End

M

Datetime

The ending value of the time span.

8

1

E

Deadline

M

Payment deadline, absolute or relative.

A

AbsoluteDeadline

O

Datetime

Defines the absolute deadline.

E

Description

O

Text description of the Payment in a given language..

A

Text

O

String

Formatted text content.

6

0..1

E

PetsPolicies

O

Property pet policies.

A

PetsAllowedCode

M

Codes

Specifies at a high level the pet policy.

7

0..9

PetPolicy

O

Pet policy

A

MaxPetQuantity

O

Integer

Maximum Number of Pets allowed in the accommodation provided.Used for Numeric values, from 0 to 99 inclusive.

RefundableDeposit

M

Money

Specifies the charge associated with a pet staying in the room.

8

0..1

E

Description

O

Text description of the pet policy in a given language..

Text

O

String

Formatted text content.

6

0..1

E

CommissionPolicy

O

Used to define the property's high-level commission policy.

A

Percent

M

Decimal

Fee percentage

A

CommissionApplicability

M

Codes

Specifies whether commissions apply to all, none, or some rates.

7

0..1

E

Description

O

Text description of the pet policy in a given language..

A

Text

O

String

Formatted text content.

4

0..n

E

AreaInfo

O

Defines well-known locations and attractions of local interest in the geographical area of the hotel facility as well as other area hotels.

5

E

RefPoints

O

A collection of reference points.

6

E

RefPoint

O

Provides information on the location of an area attraction.

A

Direction

O

String

Defines the cardinal direction (e.g., north, south, southwest).

A

Distance

O

String

Defines the distance between two points.

A

DistanceUnitName

O

String

Measure unit

A

PrimaryIndicator

O

String

indicates whether the reference point is considered the main reference point

A

RefPointCategoryCode

O

String

he code for the type of reference point

A

Proximity

O

String

Indicates the proximity (e.g., closest, second closest) between the reference point and the hotel.

A

RefPointName

O

String

The name of the reference point.

A

Latitude

O

String

The measure of the angular distance on a meridian north or south of the equator.

A

Longitud

O

String

The measure of the angular distance on a meridian east or west of the prime meridian.

A

ExistsCode

O

String

Defines whether the reference point applies.

A

ID

M

Integer

A unique identifying in CRS

E

DescriptiveText

O

String

Text description of the reference point

4

E

AffiliationInfo

O

Identifies the brand or franchise affiliations of the hotel.

E

Awards

O

A collection of Award elements.

E

Award

O

Provides detailed information regarding each award for this hotel

A

Rating

O

String

The actual award or rating received by the hotel facility

A

Provider

O

String

The name of the award or ratings provider

4

E

ContactInfo

M

Defines the contacts for consumers and technical people at the hotel facility, including various telephone numbers and e-mail addresses, or any respective attribute or affiliation for the hotel.

5

Names

M

Provides detailed name information.

6

E

Name

M

Used to pass detailed name information regarding a contact.

A

GivenName

M

String

Given name, first name or names.

A

Surname

M

String

Family name, last name.

A

JobTitle

O

String

Job title

5

E

Addresses

M

A collection of Address elements.

6

E

Address

M

A

UseType

O

Codes

The type of address

A

AddressLine

M

String

Street number and street name

A

CityName

M

String

City (e.g., Dublin), town, or postal station – i.e., a postal service territory, often used in a military address.

A

PostalCode

M

String

Postal/Zip Code number.

A

StateProv

M

String

State or Province name – i.e., Texas, Alberta

A

CountryName

M

String

Country name – i.e., Ireland.

5

E

Phones

M

A collection of Phone elements.

6

E

Phone

M

Provides detailed phone information.

A

PhoneLocationType

M

Codes

Describes the location of the phone

A

PhoneTechType

M

Codes

Indicates type of technology associated with this phone

A

PhoneUseType

M

Codes

Describes the type of telephone number

A

CountryAccessCode

M

String

Code assigned by telecommunications authorities for international country access identifier.

A

AreaCityCode

M

String

Code assigned for telephones in a specific region, city, or area.

A

PhoneNumber

M

String

Telephone number assigned to a single location.

5

E

Emails

M

The email addresses

6

E

Email

M

Provide the email address

A

EmailType

M

Codes

Defines the purpose of the email address

5

E

URLs

M

The URLs class identifies URI information.

A

URL

M

String

Provides a Website address.

A

Type

M

String

Defines the purpose of the URL address