TechRef Hotel MultiSingleAvailability 10.0 Query

Hotel_MultiSingleAvailability_10.
0_Query
Technical Reference
Amadeus IT Group, S.A.

485, Route du Pin Montard
BP 69
06902 Sophia-Antipolis Cedex
(Amadeus Proprietary and Confidential Information: unauthorized use and disclosure strictly forbidden. 2011 - Amadeus s.a.s - All Rights Reserved.)
Technical Reference
Introduction
This document is the technical reference for an Amadeus functional interface. This reference is not directly
bundled to Amadeus Programming Interface development or any other development flavour. It is just a generic
description of the interface through all the services it publishes.
Structure hierarchy
* A service contains an input message and an output message.
* A query/reply structure contains a list of simple structures and a list of grouped structures.
* A grouped structure contains a list of simple structures and a list of grouped structures.
* A simple structure contains a list of data elements and grouped data elements.
* A data element can be coded, therefore a code list is described in a separate table.
Document structure
* Service overview.
* Query and output messages for the service, with their corresponding description.
* For each query/reply structure, a table describing its higher level entities of the query/reply structure.
* For each grouped or simple structure, a table describing the entities they are built with.
* For each coded entity, a table describing the possible coded values it can take.
Grouped structures introduces the 'level' concept within a structure. This level is reflected in the
structure tables via indentation.
Document navigation
The document uses internal links to quickly navigate between referenced entities and its corresponding
structure and substructures (if any).
Technical Reference
Glossary
Element representation
Format Description
Name Type Occ Nil Description

The simple type that defines Nillable (Specifies whether an
Minimum occurences /
The element's name the textual content of an explicit null value can be The element's documentation
Maximum occurences
element assigned to the element.)
Attributes
Name Type Use Value Description

The attributes's type, if it has The attributes's use. FIXED: The attribute 'fixed' or The attribtues's
The attributes's name
a declared type optional | prohibited | required 'default' value. documentation
Technical Reference
Table of contents
1. Technical Reference 1
1.1. OTA_HotelAvailRQ 1
1.1.1. AvailRequestSegments 4
1.1.1.1. AvailRequestSegment 4
1.1.1.1.1. HotelSearchCriteria 6
1.1.1.1.1.1. Criterion 7
1.1.1.1.1.1.1. Position 8
1.1.1.1.1.1.2. Address 9
1.1.1.1.1.1.2.1. StreetNmbr 9
1.1.1.1.1.1.2.2. AddressLine 10
1.1.1.1.1.1.2.3. CityName 10
1.1.1.1.1.1.2.4. PostalCode 10
1.1.1.1.1.1.2.5. County 11
1.1.1.1.1.1.2.6. StateProv 11
1.1.1.1.1.1.2.7. CountryName 11
1.1.1.1.1.1.3. Telephone 11
1.1.1.1.1.1.4. RefPoint 12
1.1.1.1.1.1.5. CodeRef 12
1.1.1.1.1.1.6. HotelRef 13
1.1.1.1.1.1.7. Radius 15
1.1.1.1.1.1.8. AdditionalContents 16
1.1.1.1.1.1.8.1. AdditionalContent 16
1.1.1.1.1.1.9. HotelAmenity 17
1.1.1.1.1.1.10. RoomAmenity 17
1.1.1.1.1.1.11. HotelFeature 18
1.1.1.1.1.1.12. Award 18
1.1.1.1.1.1.13. Recreation 19
1.1.1.1.1.1.14. Service 19
1.1.1.1.1.1.15. Transportation 20
1.1.1.1.1.1.16. StayDateRange 20
1.1.1.1.1.1.16.1. DateWindowRange 21
1.1.1.1.1.1.17. RateRange 21
1.1.1.1.1.1.18. RatePlanCandidates 21
1.1.1.1.1.1.18.1. RatePlanCandidate 22
Technical Reference
1.1.1.1.1.1.18.1.1. MealsIncluded 23
1.1.1.1.1.1.18.1.2. ArrivalPolicy 25
1.1.1.1.1.1.18.1.3. RatePlanCommission 25
1.1.1.1.1.1.19. Profiles 25
1.1.1.1.1.1.19.1. ProfileInfo 26
1.1.1.1.1.1.19.1.1. Profile 26
1.1.1.1.1.1.19.1.1.1. Customer 27
1.1.1.1.1.1.19.1.1.1.1. CustLoyalty 27
1.1.1.1.1.1.20. RoomStayCandidates 28
1.1.1.1.1.1.20.1. RoomStayCandidate 29
1.1.1.1.1.1.20.1.1. GuestCounts 29
1.1.1.1.1.1.20.1.1.1. GuestCount 30
1.1.1.1.1.1.21. HotelMeetingFacility 31
1.1.1.1.1.1.22. UserGeneratedContent 31
2. Common Simple Types 33
2.1. AlphaLength1to2 33
2.2. AlphaLength3 33
2.3. DateOrDateTimeType 33
2.4. DateOrTimeOrDateTimeType 33
2.5. InfoSourceType 33
2.6. ISO3166 34
2.7. ListOfOTA_CodeType 34
2.8. ListOfStringLength1to8 34
2.9. Money 34
2.10. Numeric0to10 34
2.13. Numeric1to9999 35
2.14. NumericStringLength1to16 36
2.15. NumericStringLength1to5 36
2.16. OTA_CodeType 36
2.17. StateProvCodeType 36
2.18. StringLength0to128 37
Technical Reference
2.26. TimeUnitType 39
Technical Reference
1. Technical Reference
1.1. OTA_HotelAvailRQ
XPath :/OTA_HotelAvailRQ
Format Description

Requests availability of hotel properties by specific criteria that
may include: dates, date ranges, price range, room types,
regular and qualifying rates, and/or services and amenities.
OTA_HotelAvailRQ 1/1 false
The availability message can be used to get an initial
availability or to get availability for the purpose of modifying an
existing reservation.
Elements

sequence 1/1
A collection of AvailRequestSegment. Each segment includes

a collection of criteria that requests a bookable entity, which
may include designated rate plans, room types, amenities or
AvailRequestSegments 1/1 false services, and the request can be used for guest rooms or
other inventory items for which availability is sought. Each
segment would be presumed to have a unique date range for
each request.
Attributes

A reference for additional message identification, assigned by
EchoToken StringLength1to128 required the requesting host system.
Value MultiSingle.
ISO 8601 encoded timestamp indicating the creation date and

TimeStamp xs:dateTime required time of the message.
Transaction date and time. Received for tracking purposes.
Version xs:decimal required Set to value 4.000
Unique identifier to relate all messages within a transaction

TransactionIdentifier xs:string required (e.g. this would be sent in all request and response messages
that are part of an on-going transaction).
The primary language preference for the message encoded

as ISO 639-3.
PrimaryLangID xs:language required
Requested language in code
A boolean flag that indicates the return of summary

SummaryOnly xs:boolean required information in the response.
Set to "true".
Copyright 1987-2010 Amadeus IT Group SA | Page 1

Technical Reference
Defines the sort order of the returned property information.
First letter: sort by…

2nd letter: Ascending or Descending
N : No sort/random order
SortOrder optional
PA: Property name
Currently not used:
PD: Property name
CA/CD: Property code
RA/RD: Rate amount
A boolean flag that indicates the response should include

ONLY those rates that are available in the date range
specified, or whether rates that are NOT available should be
AvailRatesOnly xs:boolean optional shown. True returns only available rates; False returns all
rates.
False, if closed rates are requested
When true, the response should include rooms with an

availability status of 'on request'. When false, the response
should not include rooms with an availability status of 'on
OnRequestInd xs:boolean optional
request'.
True, if on request rates are requested.
A boolean flag that indicates the response message should

send back only the best rate available at the hotel property, as
there could be multiple room types and rates that meet the
requested criteria (e.g.: rate range). Allowing that the term
"best rate" is subjective, the intent means the lowest rate that
meets the category of the input criteria, and may have the
BestOnly xs:boolean optional
effect of limiting the return to one rate quote as opposed to
multiples.
Set to False per default

When set to True, only the best rate for each property is
returned

send back only those rates that are available within the range
RateRangeOnly xs:boolean required of the minimum and maximum amount specified.
Set to "True".

send back only those rates that are an exact match to the
requested criteria.
ExactMatchOnly xs:boolean optional
When set to True, True rate will be returned, when set to false
all roomrates returned.
AllowPartialAvail xs:boolean optional
The code specifying the currency in which the response

should be sent. Use ISO 4217, three alpha code.
RequestedCurrency AlphaLength3 optional
If this currency is present in the message, the
@CurrencyCode/ Criterion will not be taken into account
A positive integer value that indicates the maximum number of

MaxResponses xs:positiveInteger optional
responses desired in the return.

Technical Reference
A value specifying whether the data should come from the

Cache mechanism or Aggregator/Provider when no data in
cache (VeryRecent) or Cache mechanism only (LessRecent)
or Provider/Aggregator only (Live)
SearchCacheLevel optional
Current available values:
Live
VeryRecent
Mandatory for MultiSource.
If true, the response message should contain room rate

details.
RateDetailsInd xs:boolean optional
Set to "True".
Attribute: SortOrder
Variety: atomic
Base: AlphaLength1to2
Documentation: First letter: sort by…
2nd letter: Ascending or Descending
N or attribute not present: No sort/random order
PA: Property name
Currently not used:
PD: Property name
CA/CD: Property code
RA/RD: Rate amount
Enumeration description
CA Property code order, ascending.
CD Property code order, descending.
PA Property name order, ascending.
PD Property name order, descending.
RA Rates Ascending.
RD Rates descending.
Attribute: SearchCacheLevel
Variety: atomic
Base: xs:NMTOKEN
Documentation:

Technical Reference
Live
VeryRecent
LessRecent
1.1.1. AvailRequestSegments
XPath :/OTA_HotelAvailRQ/AvailRequestSegments
Format Description

A collection of AvailRequestSegment. Each segment includes
a collection of criteria that requests a bookable entity, which
may include designated rate plans, room types, amenities or
AvailRequestSegments AvailRequestSegmentsType 1/1 false services, and the request can be used for guest rooms or
other inventory items for which availability is sought. Each
segment would be presumed to have a unique date range for
each request.
Elements

sequence 1/1
To accommodate the ability to perform multiple requests

within one message, the availability request contains the
repeating element, AvailRequestSegment. Each segment
includes a collection of criteria that requests a bookable entity,
which may include designated rate plans, room types,
amenities or services, and the request can be used for guest
1/ rooms or other inventory items for which availability is sought.
AvailRequestSegment unbound false Each segment would be presumed to have a unique date
ed range for each request.
First avail request segment had all global information for the
request
All the other avail request segment identify all the other room
requested (which are different from the one in the first avail
request segment)
1.1.1.1. AvailRequestSegment
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment
Format Description

Technical Reference
To accommodate the ability to perform multiple requests

within one message, the availability request contains the
repeating element, AvailRequestSegment. Each segment
includes a collection of criteria that requests a bookable entity,
which may include designated rate plans, room types,
amenities or services, and the request can be used for guest
1/ rooms or other inventory items for which availability is sought.
AvailRequestSegment unbound false Each segment would be presumed to have a unique date
ed range for each request.
First avail request segment had all global information for the
request
All the other avail request segment identify all the other room
requested (which are different from the one in the first avail
request segment)
Elements

sequence 1/1
Availability search criteria should be specified here for

implementations using OpenTravel messages that are LATER
HotelSearchCriteria 1/1 false
than 2005B which was version 1.005 of this message, e.g.
2006A through the current specification.
Attributes

Used for MultiSource:
If set to Room then only provider supporting negotiated rates
AvailReqType optional
are returned.
If any other value is used then all provider are returned.
The availability response returns the attribute if there were

additional rates that could not fit within the availability
MoreDataEchoToken StringLength1to128 optional response. The text value should be echoed in this availability
request to indicate where to begin the next block of availability
data.
Used to specify the source of the data being exchanged as

determined by trading partners.
InfoSource InfoSourceType required These values are availbale:

Distribution for GDS
Leisure for NonGDS
MultiSource for GDS + NonGDS
Attribute: AvailReqType
Variety: atomic
Base: StringLength1to16
Documentation: In case of MultiSource:

Technical Reference
If set to Room then only provider supporting negotiated rates are returned.
If any other value is used then all provider are returned.
Room
NonRoom
Both
1.1.1.1.1. HotelSearchCriteria
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria
Format Description

Availability search criteria should be specified here for
implementations using OpenTravel messages that are LATER
HotelSearchCriteria HotelSearchCriteriaType 1/1 false
than 2005B which was version 1.005 of this message, e.g.
2006A through the current specification.
Elements

sequence 1/1
Child elements that identify a single search criterion by criteria

type. Because many of the types include partial matches to
string values such as partial addresses (street names without
a number) or partial telephone numbers (area code or three-
Criterion 1/2 false
digit prefix area, etc.) a ExactMatch attribute indicates
whether the match to the string value must be exact.
Predefined property list set in a dedicated criterion element.
Attributes

AvailableOnlyIndicator xs:boolean optional When true, return only hotels that are available.
Maybe for future use.

BestOnlyIndicator xs:boolean optional When true, return only the lowest room rate for hotels that are
available.

TotalAfterTaxOnlyInd xs:boolean optional If true, then all rates with a total amount that does not include
taxes should be excluded from the response results set.

Technical Reference
1.1.1.1.1.1. Criterion
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion
Format Description

Child elements that identify a single search criterion by criteria
type. Because many of the types include partial matches to
string values such as partial addresses (street names without
a number) or partial telephone numbers (area code or three-
Criterion HotelSearchCriterionType 1/2 false
digit prefix area, etc.) a ExactMatch attribute indicates
whether the match to the string value must be exact.
Predefined property list set in a dedicated criterion element.
Elements

sequence 1/1
The Position element contains three attributes, Latitude,

Longitude, and Altitude, used to indicate the geographic
location(s) requested by the search, expressed in notation
Position 0/1 false
specified by ISO standard 6709. It is likely that only the first
two attributes, Latitude and Longitude, would be needed to
define a geographic area.
Uses any part of address information, such as street name,

Address 0/1 false
postal code, or country code.
Telephone 0/1 false Telephone number(s) used in the search.
The Reference Point element allows for a search by proximity

RefPoint 0 / 999 false
to a designated reference point by name.
CodeRef 0/1 false Indicates the location of points of interest.
Indicates the detail of hotel reference information.
HotelRef elements:
HotelRef 0 / 99 false
Up to 4 times for Hotel Category search.
Up to 60 times for Hotel Chain search.
Up to 7 times for area location search.
Used to specify the extent of a search area. The extent is

relative to an element (position, address, hotel reference, etc.)
Radius 0/1 false
present in this ItemSearchCriterionType that specifies a
location.
A collection of Additional Content elements. Please refer to

AdditionalContents 0/1 false
userguide for usage.
sequence 1/1
Hotel level amenities for searches.

HotelAmenity 0/3 false
Support 3 facilities max in total (combination with room
amenities, recreation and business services)

Technical Reference
Room level amenities for searches.

RoomAmenity RoomAmenityPrefType 0/3 false
Support 3 amenities max in total
HotelFeature 0 / 10 false Used to search for hotels based on hotel features.
Award 0/3 false An element that identifies the hotel ratings.
Recreation 0/3 false Identifies recreation facilities or amenities of interest.
Service 0/3 false Identifies business services of interest.
Transportation 0/5 false Identifies transportation facilities.
Range of dates, or fixed set of dates for Availability Request.

StayDateRange DateTimeSpanType 0/1 false Date range can also be specified by using start dates and
number of nights (minimum, maximum or fixed).
RateRange 0/1 false One rate range used for currency and rate range request
RatePlanCandidates 0/1 false Collection of requested rate plans.
A collection of profile objects or unique IDs of profiles.

Profiles ProfilesType 0/1 false
(frequent traveller and guest ID)
RoomStayCandidates 0/1 false Collection of room stay candidates.
0/ For future use.

HotelMeetingFacility unbound false Used to search for hotels based on meeting facility
ed requirements.
For future use.

UserGeneratedContent 0/1 false
Information linked to user content.
Attributes

Values of "true" or "false", indicating whether the string of the
search value must be an exact match.
ExactMatch xs:boolean required
Default value "true".
1.1.1.1.1.1.1. Position
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Position
Format Description

The Position element contains three attributes, Latitude,
Longitude, and Altitude, used to indicate the geographic
location(s) requested by the search, expressed in notation
Position 0/1 false
specified by ISO standard 6709. It is likely that only the first
two attributes, Latitude and Longitude, would be needed to
define a geographic area.
Attributes

Technical Reference

The measure of the angular distance on a meridian north or
Latitude StringLength1to16 required
south of the equator.
The measure of the angular distance on a meridian east or

Longitude StringLength1to16 required
west of the prime meridian.
1.1.1.1.1.1.2. Address
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address
Format Description

Uses any part of address information, such as street name,
Address AddressType 0/1 false
postal code, or country code.
Elements

sequence 1/1
StreetNmbr 0/1 false May contain the street number and optionally the street name.
When the address is unformatted (FormattedInd="false")

these lines will contain free form address details. When the
address is formatted and street number and street name must
AddressLine StringLength1to255 0/5 false
be sent independently, the street number will be sent using
StreetNmbr, and the street name will be sent in the first
AddressLine occurrence.
City (e.g., Dublin), town, or postal station (i.e., a postal service

CityName StringLength1to64 0/1 false
territory, often used in a military address).
PostalCode StringLength1to16 0/1 false Post Office Code number.
County StringLength1to32 0/1 false County or Region Name (e.g., Fairfax).
StateProv StateProvType 0/1 false State or Province name (e.g., Texas).
CountryName CountryNameType 0/1 false Country name (e.g., Ireland).
1.1.1.1.1.1.2.1. StreetNmbr
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address/StreetNmbr
Format Description

StreetNmbr StringLength0to64 0/1 false May contain the street number and optionally the street name.

Technical Reference
Attributes

PO_Box StringLength1to16 optional Defines a Post Office Box number.
Usually a letter right after the street number (A in 66-A, B in

StreetNmbrSuffix StringLength1to8 optional
123-B etc).
StreetDirection StringLength1to8 optional Street direction of an address (e.g., N, E, S, NW, SW).
Numerical equivalent of a rural township as defined within a

RuralRouteNmbr NumericStringLength1to5 optional
given area (e.g., 12, 99).
1.1.1.1.1.1.2.2. AddressLine
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address/AddressLine
Format Description

When the address is unformatted (FormattedInd="false")
these lines will contain free form address details. When the
address is formatted and street number and street name must
AddressLine StringLength1to255 0/5 false
be sent independently, the street number will be sent using
StreetNmbr, and the street name will be sent in the first
AddressLine occurrence.
1.1.1.1.1.1.2.3. CityName
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address/CityName
Format Description

City (e.g., Dublin), town, or postal station (i.e., a postal service
CityName StringLength1to64 0/1 false
territory, often used in a military address).
1.1.1.1.1.1.2.4. PostalCode
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address/PostalCode
Format Description

PostalCode StringLength1to16 0/1 false Post Office Code number.

Technical Reference
1.1.1.1.1.1.2.5. County
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address/County
Format Description

County StringLength1to32 0/1 false County or Region Name (e.g., Fairfax).
1.1.1.1.1.1.2.6. StateProv
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address/StateProv
Format Description

StateProv StringLength0to64 0/1 false State or Province name (e.g., Texas).
Attributes

The standard code or abbreviation for the state, province, or
StateCode StateProvCodeType required
region.
1.1.1.1.1.1.2.7. CountryName
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Address/CountryName
Format Description

CountryName StringLength0to64 0/1 false Country name (e.g., Ireland).
Attributes

Code ISO3166 required ISO 3166 code for a country.

Technical Reference
1.1.1.1.1.1.3. Telephone
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Telephone
Format Description

Telephone 0/1 false Telephone number(s) used in the search.
Attributes

PhoneNumber StringLength1to32 required Telephone number assigned to a single location.
1.1.1.1.1.1.4. RefPoint
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/RefPoint
Format Description

The Reference Point element allows for a search by proximity
RefPoint StringLength0to64 0 / 999 false
to a designated reference point by name.
Attributes

StateProv StateProvCodeType optional The state or province in which the reference point is located.
CountryCode ISO3166 optional The country in which the reference point is located.
Any code used to specify an item, for example, type of

Code StringLength1to8 optional
traveler, service code, room amenity, etc.
CodeContext StringLength1to32 optional Set to "1A POR"
Indicates the type of location being referenced (e.g., Airport,

Hotel). Refer to the OpenTravel Code table Index Point Code
RefPointType OTA_CodeType optional
(IPC).
POR Category, code table IPC
Name StringLength1to128 optional The name of the reference point.
1.1.1.1.1.1.5. CodeRef
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/CodeRef

Technical Reference
Format Description

CodeRef xs:string 0/1 false Indicates the location of points of interest.
Attributes

LocationCode StringLength1to16 required IATA location for point of reference search
CodeContext StringLength1to32 required Set to "IATA"
1.1.1.1.1.1.6. HotelRef
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/HotelRef
Format Description

Indicates the detail of hotel reference information.
HotelRef elements:
HotelRef 0 / 99 false
Up to 4 times for Hotel Category search.
Up to 60 times for Hotel Chain search.
Up to 7 times for area location search.
Attributes

The code that identifies a hotel chain or management group.
The hotel chain code is decided between vendors. This
ChainCode StringLength1to8 optional
attribute is optional if the hotel is an independent property that
can be identified by the HotelCode attribute.
The code that uniquely identifies a single hotel property. The

hotel code is decided between vendors.
HotelCode StringLength1to16 optional
Only used in the dedicated criterion element for search by
predefined property list.
HotelCityCode StringLength1to8 optional The IATA city code; for example DCA, ORD.
HotelName StringLength1to128 optional A text field used to communicate the proper name of the hotel.
A text field used to communicate the context (or source of - ex

Sabre, Galileo, Worldspan, Amadeus) the
HotelCodeContext StringLength1to32 optional HotelReferenceGroup codes.
Set to "1A".

Technical Reference
Used to search for hotels within a particular market segment.

SegmentCategoryCode OTA_CodeType * optional Refer to OpenTravel Code Segment Category Code Type
(SEG).
Refer to OpenTravel Code list OpenTravel Code List Property

PropertyClassCode OTA_CodeType optional
Class Type (PCT).
The level of integration of a property to provide automated

transaction information. The lower the number, the higher the
integration (e.g., a 1 means the supplier has the highest level
of integration automation).
SupplierIntegrationLevel xs:nonNegativeInteger optional
Access Level
0- Standard Access
1- Complete Access
2- Complete Access Plus
3- Dynamic Access
Used to search for hotels in a specific location category (e.g.

LocationCategoryCode OTA_CodeType * optional downtown, airport or suburban, etc.). Refer to OpenTravel
Code List Location Category Codes (LOC).
When true indicates the search should be performed beyond

ExtendedCitySearchIndicator xs:boolean optional the hotel city code, typically this could include neighboring
cities to the specified hotel city code.
Attribute: SegmentCategoryCode
Variety: atomic
Base: xs:string
Documentation: Available codes:
Tourist – OTA SEG code 13
Standard – OTA SEG code 16
First – OTA SEG code 7
Luxury – OTA SEG code 8
Restriction Value
pattern [0-9A-Z]{1,3}(\.[A-Z]{3}(\.X){0,1}){0,1}
13 Tourist
16 Standard
7 First
8 Luxury
Attribute: LocationCategoryCode
Variety: atomic

Technical Reference
Base: xs:string
Documentation: available codes:
Area location:
Code table LOC
9- North
12- South
5- East
14- West
1- Airport
4- Dowtown
10- Resort
Restriction Value
pattern [0-9A-Z]{1,3}(\.[A-Z]{3}(\.X){0,1}){0,1}
9 North
12 South
5 East
14 West
1 Airport
4 Downtown
10 Resort
1.1.1.1.1.1.7. Radius
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Radius
Format Description

Used to specify the extent of a search area. The extent is
relative to an element (position, address, hotel reference, etc.)
Radius 0/1 false
present in this ItemSearchCriterionType that specifies a
location.
Attributes

Technical Reference
An optional attribute indicating the distance to/from a

Distance NumericStringLength1to16 required
reference point.
Indicates if the search should be sorted by distance or

DistanceMeasure StringLength1to16 optional
random: DIS – sorted by distance RND – random
Unit of the distance:

UnitOfMeasureCode OTA_CodeType required 1-Miles
2-Kilometers
1.1.1.1.1.1.8. AdditionalContents
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/AdditionalContents
Format Description

A collection of Additional Content elements. Please refer to
AdditionalContents 0/1 false
userguide for usage.
Elements

sequence 1/1
1/
AdditionalContent unbound false Describes the specific content requested.
ed
1.1.1.1.1.1.8.1. AdditionalContent
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/AdditionalContents/
AdditionalContent
Format Description

1/
AdditionalContent unbound false Describes the specific content requested.
ed
Attributes

When used, the response message will be filtered to return
ContentGroupCode OTA_CodeType required only the content that was requested. Refer to OpenTravel
code list Information Type (INF).

Technical Reference
CodeDetail StringLength1to128 optional May be used to give further detail on the code.
If true, this item is obsolete and should be removed from the

Removal xs:boolean optional
receiving system.
1.1.1.1.1.1.9. HotelAmenity
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/HotelAmenity
Format Description

Hotel level amenities for searches.
HotelAmenity 0/3 false
Support 3 facilities max in total (combination with room
amenities, recreation and business services)
Attributes

An amenity available to guests that applies to the property as
a whole (hotel level) versus an individual guest or meeting
Code OTA_CodeType required
room type. Refer to OpenTravel Code List Hotel Amenity
Code (HAC).
For future use.

EquivalenceGroup optional A method to associate amenities into logical groups by
specifying AND/ OR conditions.
Attribute: EquivalenceGroup
Variety: atomic
Base: xs:positiveInteger
Documentation:
Restriction Value
mininclusive 1
maxinclusive 3
1.1.1.1.1.1.10. RoomAmenity
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/RoomAmenity

Technical Reference
Format Description

Room level amenities for searches.
RoomAmenity StringLength0to128 0/3 false
Support 3 amenities max in total
Attributes

Identifes the types of room amenities offered by the property.
RoomAmenity OTA_CodeType required
Refer to OpenTravel Code List Room Amenity Type (RMA).
1.1.1.1.1.1.11. HotelFeature
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/HotelFeature
Format Description

HotelFeature 0 / 10 false Used to search for hotels based on hotel features.
Attributes

Hotel security feature that is used as a qualifier when
SecurityFeatureCode OTA_CodeType optional searching for properties. Refer to OpenTravel Code list
Security Feature Code (SEC).
Hotel accessibility feature that is used as a qualifier when

AccessibilityCode OTA_CodeType optional searching for properties. Refer to OpenTravel Code list
Disability Feature Code (PHY).
1.1.1.1.1.1.12. Award
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Award
Format Description

Award 0/3 false An element that identifies the hotel ratings.

Technical Reference
Attributes

Provider xs:string required The name of the award: AAA, MOB, MIC, LSR, NSM
The actual award or rating received by the hotel facility.

Rating values:
Rating xs:string optional
For AAA, MOB, MIC, LSR, NSM, value possible are 1 to 5
For OHG value possible are D, F, T
1.1.1.1.1.1.13. Recreation
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Recreation
Format Description

Recreation 0/3 false Identifies recreation facilities or amenities of interest.
Attributes

Used to identify a specific recreation activity. Refer to
OpenTravel Code list Recreation Srvc Type (RST).
1.1.1.1.1.1.14. Service
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Service
Format Description

Service 0/3 false Identifies business services of interest.
Attributes

Used to identify a specific business service. Refer to
BusinessServiceCode OTA_CodeType optional
OpenTravel Code list Business Srvc Type (BUS).
Today all the Service codes we are using in our process are
ServiceInventoryCode StringLength1to16 optional mapped to different OTA code list. This field contains those
services
Quantity Numeric1to999 optional The number of services (e.g., tickets, rounds of golf).

Technical Reference
1.1.1.1.1.1.15. Transportation
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Transportation
Format Description

Transportation 0/5 false Identifies transportation facilities.
Attributes

Used to define the mode of available transportation. Refer to
OpenTravel Code List Transportation Code (TRP).
1.1.1.1.1.1.16. StayDateRange
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/StayDateRange
Format Description

Range of dates, or fixed set of dates for Availability Request.
StayDateRange DateTimeSpanType 0/1 false Date range can also be specified by using start dates and
number of nights (minimum, maximum or fixed).
Elements

choice 1/1
Specifies a time period that can be applied before and/or after

DateWindowRange TimeInstantType 1/1 false
the start date.
sequence 1/1
Attributes

Start DateOrTimeOrDateTimeType optional The starting value of the time span.
End DateOrTimeOrDateTimeType optional The ending value of the time span.

Technical Reference
1.1.1.1.1.1.16.1. DateWindowRange
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/StayDateRange/
DateWindowRange
Format Description

Specifies a time period that can be applied before and/or after
DateWindowRange DateOrDateTimeType 1/1 false
the start date.
1.1.1.1.1.1.17. RateRange
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/RateRange
Format Description

RateRange 0/1 false One rate range used for currency and rate range request
Attributes

A decimal value that indicates the minimum monetary value to
MinRate Money optional
be considered in a request for an available product.
A decimal value that indicates the maximum monetary value

MaxRate Money optional
to be considered in a request for an available product.
RateTimeUnit TimeUnitType optional Used to specify the period of time to which the rates apply.
An ISO 4217 (3) alpha character code that specifies a

monetary unit.
CurrencyCode AlphaLength3 optional
If not specified, currency of the location. If specified it will
translate into this currency.
The ISO 4217 standard "minor unit" for the number of decimal
DecimalPlaces xs:nonNegativeInteger optional
places for a particular currency.
For future use.
RateMode OTA_CodeType optional This supports returning a type of rate (minimum, maximum,
etc.) as an alternative to returning a specific rate. Refer to
OpenTravel Code List Rate Mode (RMO).
For future use.

MaxResponses xs:positiveInteger optional A positive integer value that indicates the maximum number of
responses desired in the return.

Technical Reference
1.1.1.1.1.1.18. RatePlanCandidates
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/RatePlanCandidates
Format Description

RatePlanCandidates RatePlanCandidatesType 0/1 false Collection of requested rate plans.
Elements

sequence 1/1
Element used to identify available products and rates.

RatePlanCandidate 1/9 false
An individual rate plan candidate
1.1.1.1.1.1.18.1. RatePlanCandidate
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/RatePlanCandidates/
RatePlanCandidate
Format Description

Element used to identify available products and rates.
RatePlanCandidate 1/9 false
An individual rate plan candidate
Elements

sequence 1/1
MealsIncluded 0/1 false Defines which meals are included with this rate plan.
ArrivalPolicy 0/1 false Defines policy types for this rate plan.
RatePlanCommission 0/1 false Defines commission attributes for this rate plan.
Attributes

Technical Reference
An enumerated type that allows the query to specify a rate

category type, and provides major categories for comparison
RatePlanType OTA_CodeType optional across brands. Refer to OpenTravel Code List Rate Plan Type
(RPT).
dealing with the RateCategories ( WKD / PRO / GOV ... )
A string value to request a particular code or an ID if the guest

RatePlanCode StringLength1to64 optional qualifies for a specific rate, a corporate rate, or a negotiated
rate.
RatePlanID StringLength1to64 optional Special ID code associated with the rate (Corporate ID)

Promotion code is the identifier used by the host to link
directly with a specific named advertising campaign. By
PromotionCode StringLength1to32 optional including the required code, the client is able to gain access to
special offers which may have been created for a specifically
targeted group via a CRM system or for a wider advertising
campaign using Television or press adverts.
maybe for future use.

PromotionVendorCode ListOfStringLength1to8 optional
List of the vendor codes associated with a promotion.
Hotel systems often group multiple rate plans into a single

category. This refers to that category that is specific to the
RatePlanCategory StringLength1to64 optional
hotel CRS/ PMS and should not be confused with a GDS rate
category.
For future use.

PrepaidQualifier optional Qualifies whether the response should include prepaid rates,
exclude prepaid rates, or include prepaid rates only.
Attribute: PrepaidQualifier
Variety: atomic
Base: xs:NMTOKEN
Documentation:
IncludePrepaid Return prepaid and non-prepaid rates.
PrepaidOnly Only return prepaid rates.
ExcludePrepaid Exclude prepaid rates from the response.
1.1.1.1.1.1.18.1.1. MealsIncluded
RatePlanCandidate/MealsIncluded
Format Description

MealsIncluded 0/1 false Defines which meals are included with this rate plan.

Technical Reference
Attributes

When true, indicates breakfast is included.
Breakfast xs:boolean optional
Used for Distribution.
Used to identify the types of meals included with a rate plan.

MealPlanCodes ListOfOTA_CodeType * optional
Refer to OpenTravel Code List Meal Plan Type (MPT).
Attribute: MealPlanCodes
Variety: list
Item type: OTA_CodeType *

Documentation: Used to identify the types of meals included with a rate plan. Refer to OpenTravel Code List Meal Plan Type (MPT).
Item type
Variety: atomic
Base: xs:string
Documentation: Available codes for Leisure/MultiSource.
1All inclusive
3Breakfast
10Full Board
12Half Board
14Room only
Restriction Value
pattern [0-9A-Z]{1,3}(\.[A-Z]{3}(\.X){0,1}){0,1}
1 All inclusive
3 Breakfast
10 Full Board
12 Half Board
14 Room only

Technical Reference
1.1.1.1.1.1.18.1.2. ArrivalPolicy
RatePlanCandidate/ArrivalPolicy
Format Description

ArrivalPolicy 0/1 false Defines policy types for this rate plan.
Attributes

GuaranteePolicyIndicator xs:boolean optional When true, return rates with a guarantee policy.
DepositPolicyIndicator xs:boolean optional When true, return rates with a deposit policy.
HoldTimePolicyIndicator xs:boolean optional When true, return rates with a hold time policy.
1.1.1.1.1.1.18.1.3. RatePlanCommission
RatePlanCandidate/RatePlanCommission
Format Description

RatePlanCommission 0/1 false Defines commission attributes for this rate plan.
Attributes

CommissionableIndicator xs:boolean optional When true, indicates the rate requested is commissionable.
1.1.1.1.1.1.19. Profiles
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Profiles
Format Description

Technical Reference
A collection of profile objects or unique IDs of profiles.

Profiles ProfilesType 0/1 false
(frequent traveller and guest ID)
Elements

sequence 1/1
ProfileInfo 1/2 false An individual Profile
1.1.1.1.1.1.19.1. ProfileInfo
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Profiles/ProfileInfo
Format Description

ProfileInfo 1/2 false An individual Profile
Elements

sequence 1/1
Provides detailed information regarding either a company or

Profile ProfileType 1/1 false
a customer profile.
1.1.1.1.1.1.19.1.1. Profile
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Profiles/ProfileInfo/Profile
Format Description

Provides detailed information regarding either a company or
Profile ProfileType 1/1 false
a customer profile.
Elements

sequence 1/1
Customer CustomerType 1/1 false Detailed customer information for this profile.

Technical Reference
1.1.1.1.1.1.19.1.1.1. Customer
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Profiles/ProfileInfo/Profile/
Customer
Format Description

Customer CustomerType 1/1 false Detailed customer information for this profile.
Elements

sequence 1/1
CustLoyalty 1/1 false Loyalty program information for the customer.
Attributes

Gender optional Identifies the gender.
Attribute: Gender
Variety: atomic
Base: xs:NMTOKEN
Documentation:
Male
Female
Unknown
Male_NoShare
Female_NoShare
1.1.1.1.1.1.19.1.1.1.1. CustLoyalty

Technical Reference
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/Profiles/ProfileInfo/Profile/
Customer/CustLoyalty
Format Description

CustLoyalty 1/1 false Loyalty program information for the customer.
Elements

sequence 1/1
Attributes

Identifier to indicate the company owner of the loyalty
program.
ProgramID StringLength1to16 optional
2 letter program ID, will be the chain code for ID and the
airline code for FT
Unique identifier of the member in the program (membership

MembershipID StringLength1to32 required
number, account number, etc.).
Identifies the travel sector.

TravelSector OTA_CodeType required
TravelSector=”1” for FT (air) TravelSector=”3” forID (hotel)
1.1.1.1.1.1.20. RoomStayCandidates
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/RoomStayCandidates
Format Description

RoomStayCandidates 0/1 false Collection of room stay candidates.
Elements

sequence 1/1
RoomStayCandidate RoomStayCandidateType 1/1 false Element used to identify available room products.

Technical Reference
1.1.1.1.1.1.20.1. RoomStayCandidate
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/RoomStayCandidates/
RoomStayCandidate
Format Description

RoomStayCandidate RoomStayCandidateType 1/1 false Element used to identify available room products.
Elements

sequence 1/1
GuestCounts GuestCountType 0/1 false
Attributes

RoomTypeCode StringLength1to16 optional Specific system room type code, ex: A1K, A1Q etc.
Indicates the category of the room. Typical values would be

RoomCategory OTA_CodeType optional Moderate, Standard, or Deluxe. Refer to OpenTravel Code
List Segment Category Code (SEG).
A string value representing the unique identification of a room

if the request is looking for a specific room.
RoomID StringLength1to16 optional
Mandatory for Leisure and MultiSource.
Indicates the view of the room. Typical values would be

RoomViewCode OTA_CodeType optional "Ocean view", "Pool view" or "Garden View". Refer to
OpenTravel Code List Room View Type (RVT).
Indicates the type of bed(s) found in the room. Typical values

would be Double, Twin, Queen, or King. Refer to OpenTravel
Code List Bed Type Code (BED).
BedTypeCode ListOfOTA_CodeType optional
Subset used:
Double: BedTypeCode="1", King: BedTypeCode="3", Queen:
BedTypeCode="5", Twins: BedTypeCode="8", Single:
BedTypeCode="9”
Defines the number of the item in question.

Quantity Numeric1to9999 optional
Multiple identical room only
Specifies the room classification (e.g., cabin, apartment).

RoomClassificationCode OTA_CodeType optional
Refer to OpenTravel Code List Guest Room Info (GRI).
1.1.1.1.1.1.20.1.1. GuestCounts

Technical Reference
RoomStayCandidate/GuestCounts
Format Description

GuestCounts GuestCountType 0/1 false
Elements

sequence 1/1
A recurring element that identifies the number of guests and

GuestCount 1 / 99 false
ages of the guests.
Attributes

IsPerRoom xs:boolean optional True, all guests share the same room
1.1.1.1.1.1.20.1.1.1. GuestCount
RoomStayCandidate/GuestCounts/GuestCount
Format Description

A recurring element that identifies the number of guests and
GuestCount 1 / 99 false
ages of the guests.
Attributes

A code representing a business rule that determines the
charges for a guest based upon age range (e.g. Adult, Child,
AgeQualifyingCode OTA_CodeType optional Senior, Child With Adult, Child Without Adult). This attribute
allows for an increase in rate by occupant class. Refer to
OpenTravel Code List Age Qualifying Code (AQC).
Age Numeric0to999 optional Defines the age of a guest.
Count Numeric1to999 optional The number of guests in one AgeQualifyingCode or Count.

Technical Reference
1.1.1.1.1.1.21. HotelMeetingFacility
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/HotelMeetingFacility
Format Description

0/ For future use.
HotelMeetingFacility unbound false Used to search for hotels based on meeting facility
ed requirements.
Attributes

The total number of unique meeting rooms provided at the
hotel facility. For example, if the hotel has a grand ballroom
MeetingRoomCount xs:nonNegativeInteger optional
that breaks into Salon A, B, and C -the total number of unique
meeting rooms is three.
The largest seating capacity available in the largest meeting

LargestSeatingCapacity xs:nonNegativeInteger optional
room - generally this is for theatre-style room setup.
The amount of room space for the largest unique meeting

LargestRoomSpace xs:nonNegativeInteger optional
room at the hotel facility.
The unit of measure in a code format (e.g., inches, pixels,

UnitOfMeasureCode OTA_CodeType optional centimeters). Refer to OpenTravel Code List Unit of Measure
Code (UOM).
Used as a qualifier when searching for properties. Refer to

MeetingRoomCode OTA_CodeType optional
OpenTravel Code list Meeting Room Code (MRC).
1.1.1.1.1.1.22. UserGeneratedContent
XPath :/OTA_HotelAvailRQ/AvailRequestSegments/AvailRequestSegment/HotelSearchCriteria/Criterion/UserGeneratedContent
Format Description

For future use.
UserGeneratedContent 0/1 false
Information linked to user content.
Attributes

TypeOfRating optional Identifies the parameters around the rating search.
Rating Numeric0to10 optional User rating for the property on which the search is made.

Technical Reference
Attribute: TypeOfRating
Variety: atomic
Base: xs:NMTOKEN
Documentation:
EqualTo The search results should include only exact matches for the value found in
the Rating attribute.
GreaterThan The search results should include any matches that are greater than the
value found in the Rating attribute.
LessThan The search results should include any matches that are less than the value
found in the Rating attribute.
EqualToOrGreaterThan The search results should include any matches that are equal to greater than
the value found in the Rating attribute.
EqualToOrLessThan The search results should include any matches that are equal to or less than
the value found in the Rating attribute.

Technical Reference
2. Common Simple Types

2.1. AlphaLength1to2
Variety: atomic
Base: xs:string
Documentation: Used for an Alpha String, length 1 to 2.
Restriction Value
pattern [a-zA-Z]{1,2}
2.2. AlphaLength3
Variety: atomic
Base: xs:string
Documentation: An ISO 4217 (3) alpha character code that specifies a monetary unit.
Restriction Value
pattern [a-zA-Z]{3}
2.3. DateOrDateTimeType
Variety: union
Member types: xs:date xs:dateTime
Documentation: A construct to validate either a date or a dateTime value.
2.4. DateOrTimeOrDateTimeType
Variety: union
Member types: xs:date xs:dateTime xs:time
Documentation: The starting value of the time span.
2.5. InfoSourceType
Variety: atomic
Base: xs:string
Documentation: Used to specify the source of the data being exchanged as determined by trading partners.
Restriction Value

Technical Reference
minlength 1
maxlength 32
2.6. ISO3166
Variety: atomic
Base: xs:string
Documentation: ISO 3166 code for a country.
Restriction Value
pattern [a-zA-Z]{2}
2.7. ListOfOTA_CodeType
Variety: list
Item type: OTA_CodeType
Documentation: Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Refer to
OpenTravel Code List Bed Type Code (BED).
2.8. ListOfStringLength1to8
Variety: list
Item type: StringLength1to8
Documentation: List of the vendor codes associated with a promotion.
2.9. Money
Variety: atomic
Base: xs:decimal
Documentation: A decimal value that indicates the minimum monetary value to be considered in a request for an available
product.
Restriction Value
fractiondigits 3
2.10. Numeric0to10

Technical Reference
Variety: atomic
Base: xs:integer
Documentation: User rating for the property on which the search is made.
Restriction Value
mininclusive 0
maxinclusive 10
2.11. Numeric0to999
Variety: atomic
Base: xs:integer
Documentation: Defines the age of a guest.
Restriction Value
mininclusive 0
maxinclusive 999
2.12. Numeric1to999
Variety: atomic
Base: xs:integer
Documentation: The number of services (e.g., tickets, rounds of golf).
Restriction Value
mininclusive 1
maxinclusive 999
2.13. Numeric1to9999
Variety: atomic
Base: xs:integer
Documentation: Defines the number of the item in question.
Restriction Value
mininclusive 1
maxinclusive 9999

Technical Reference
2.14. NumericStringLength1to16
Variety: atomic
Base: xs:string
Documentation: An optional attribute indicating the distance to/from a reference point. When used in conjunction with
DistanceMax, this represents the minimum distance.
Restriction Value
pattern [0-9]{1,16}
2.15. NumericStringLength1to5
Variety: atomic
Base: xs:string
Documentation: Numerical equivalent of a rural township as defined within a given area (e.g., 12, 99).
Restriction Value
pattern [0-9]{1,5}
2.16. OTA_CodeType
Variety: atomic
Base: xs:string
Documentation: Indicates the type of location being referenced (e.g., Airport, Hotel). Refer to the OpenTravel Code table Index
Point Code (IPC).
Restriction Value
pattern [0-9A-Z]{1,3}(\.[A-Z]{3}(\.X){0,1}){0,1}
2.17. StateProvCodeType
Variety: atomic
Documentation: The standard code or abbreviation for the state, province, or region.
Restriction Value
minlength 2

Technical Reference
2.18. StringLength0to128
Variety: atomic
Base: xs:string
Documentation: Used for Character Strings, length 0 to 128.
Restriction Value
minlength 0
maxlength 128
Variety: atomic
Base: xs:string
Documentation: Used for Character Strings, length 0 to 64.
Restriction Value
minlength 0
maxlength 64
Variety: atomic
Base: xs:string
Documentation: The name of the reference point.
Restriction Value
minlength 1
maxlength 128
Variety: atomic
Base: xs:string
Documentation: The measure of the angular distance on a meridian north or south of the equator.
Restriction Value

Technical Reference
minlength 1
maxlength 16
Variety: atomic
Base: xs:string
Documentation: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When
the address is formatted and street number and street name must be sent independently, the street number will be sent using
StreetNmbr, and the street name will be sent in the first AddressLine occurrence.
Restriction Value
minlength 1
maxlength 255
Variety: atomic
Base: xs:string
Documentation: County or Region Name (e.g., Fairfax).
Restriction Value
minlength 1
maxlength 32
Variety: atomic
Base: xs:string
Documentation: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
Restriction Value
minlength 1
maxlength 64

Technical Reference
Variety: atomic
Base: xs:string
Documentation: Usually a letter right after the street number (A in 66-A, B in 123-B etc).
Restriction Value
minlength 1
maxlength 8
2.26. TimeUnitType
Variety: atomic
Documentation: Used to specify the period of time to which the rates apply.
Year
Month
Week
Day
Hour
Second
FullDuration
Minute

TechRef Hotel MultiSingleAvailability 10.0 Query

Diunggah oleh

Informasi Dokumen

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

TechRef Hotel MultiSingleAvailability 10.0 Query

Diunggah oleh

Hak Cipta:

Format Tersedia

Hotel_MultiSingleAvailability_10.

Amadeus IT Group, S.A.

Name Type Occ Nil Description

Name Type Use Value Description

2. Common Simple Types 33

Name Type Occ Nil Description

Name Type Occ Nil Description

A collection of AvailRequestSegment. Each segment includes

Name Type Use Value Description

ISO 8601 encoded timestamp indicating the creation date and

Version xs:decimal required Set to value 4.000

Unique identifier to relate all messages within a transaction

The primary language preference for the message encoded

A boolean flag that indicates the return of summary

Copyright 1987-2010 Amadeus IT Group SA | Page 1

Defines the sort order of the returned property information.

First letter: sort by…

A boolean flag that indicates the response should include

False, if closed rates are requested

When true, the response should include rooms with an

True, if on request rates are requested.

A boolean flag that indicates the response message should

Set to False per default

A boolean flag that indicates the response message should

A boolean flag that indicates the response message should

AllowPartialAvail xs:boolean optional

The code specifying the currency in which the response

A positive integer value that indicates the maximum number of

Copyright 1987-2010 Amadeus IT Group SA | Page 2

A value specifying whether the data should come from the

Mandatory for MultiSource.

If true, the response message should contain room rate

Documentation: First letter: sort by…

2nd letter: Ascending or Descending

N or attribute not present: No sort/random order

PA: Property name

Currently not used:

PD: Property name

CA/CD: Property code

RA/RD: Rate amount

CD Property code order, descending.

PA Property name order, ascending.

PD Property name order, descending.

Copyright 1987-2010 Amadeus IT Group SA | Page 3

Name Type Occ Nil Description

Name Type Occ Nil Description

To accommodate the ability to perform multiple requests

Name Type Occ Nil Description

Copyright 1987-2010 Amadeus IT Group SA | Page 4

To accommodate the ability to perform multiple requests

Name Type Occ Nil Description

Availability search criteria should be specified here for

Name Type Use Value Description

The availability response returns the attribute if there were

Used to specify the source of the data being exchanged as

InfoSource InfoSourceType required These values are availbale:

Documentation: In case of MultiSource:

Copyright 1987-2010 Amadeus IT Group SA | Page 5

If any other value is used then all provider are returned.

Name Type Occ Nil Description

Name Type Occ Nil Description

Child elements that identify a single search criterion by criteria

Predefined property list set in a dedicated criterion element.

Name Type Use Value Description