OpenTravel 2020A Hotel Descriptive Content Resource
Swagger 2.0 resource contract generated from the OpenTravel 2.0 Object Model, 2020A Object Suite. Defines three operations for hotel descriptive content — GET /HotelDescriptiveContents, POST /HotelDescriptiveContents/Query and POST /HotelDescriptiveContents/Notifications — with 337 model definitions. This is a specification artifact published by the standards body for implementers to host themselves; the document declares host 127.0.0.1 and basePath /v1_0 and OpenTravel operates no runtime endpoint for it.
OpenTravel 2020A Hotel Descriptive Content Resource is one of 4 APIs that OpenTravel Alliance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Hospitality, Hotels, Content, and OpenTravel 2.0. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.
This API exposes 3 operations across 3 paths, and defines 337 schemas. It is described by OpenAPI 2.0, at version 1.0.0.
3 operations
3 paths
337 schemas
1 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Operations 3
GET
/HotelDescriptiveContents
HotelDescriptiveContentResource - Get
POST
/HotelDescriptiveContents/Notifications
HotelDescriptiveContentResource - Notification
POST
/HotelDescriptiveContents/Query
HotelDescriptiveContentResource - Query
Schemas 337
The contract defines 337 schemas that model the data the API accepts and returns. The most detailed are TypeRoom (27 properties), Restaurant (20 properties), GuestRoom (20 properties), MeetingRoom (19 properties). Each schema is shown below with its type and property counts.
GuaranteesAccepted
object
11 properties
1 required
PaymentsAccepted
object
11 properties
1 required
Deadline
object
3 properties
1 required
DeadlineTimePeriod
DeadlineAbsoluteDate
RoomOccupancy
object
6 properties
1 required
BasicPropertyInfo
object
7 properties
1 required
Site
object
7 properties
1 required
BasicPropertyInfoDetail
SiteDetail
HotelDescriptiveContentListResponse
object
5 properties
1 required
HotelDescriptiveContentQueryInfo
object
4 properties
1 required
HotelDescriptiveContentQueryGet
object
4 properties
2 required
Recreation
object
17 properties
1 required
HotelDescriptiveContentID
object
4 properties
1 required
HotelDescriptiveContent
HotelDescriptiveContentQueryHotels
object
4 properties
1 required
CategoryCodes
object
7 properties
1 required
GuestRoomInfo
object
7 properties
1 required
Service
object
15 properties
1 required
ServiceBusiness
ServiceHotelAmenity
ServiceMealPlan
ServiceMeetingRoom
DescriptiveContentFeatureSecurity
DescriptiveContentFeatureAccessibility
FacilityInfo
object
5 properties
1 required
GuestRooms
object
4 properties
1 required
GuestRoom
object
20 properties
1 required
TypeRoom
object
27 properties
1 required
DescriptiveContentAmenity
object
10 properties
1 required
HotelPolicies
object
6 properties
1 required
HotelPolicy
object
15 properties
1 required
HotelCancelPolicy
object
4 properties
1 required
HotelPolicyInformation
object
14 properties
1 required
TaxPolicies
object
3 properties
1 required
TaxPolicy
object
11 properties
1 required
PetPolicy
object
10 properties
1 required
PetPolicies
object
4 properties
1 required
FeePolicy
object
11 properties
1 required
FeePolicies
object
3 properties
1 required
RatePolicy
object
10 properties
1 required
RatePolicies
object
3 properties
1 required
GroupPolicies
object
5 properties
1 required
Role_Enum
string
GroupPolicy
object
4 properties
1 required
RecreationFeature
object
5 properties
1 required
OtherHotel
object
7 properties
1 required
DistributionSystem
object
4 properties
1 required
Brand
object
5 properties
1 required
PartnerInfo
object
4 properties
1 required
GDS_Information
object
5 properties
1 required
GDS_Codes
object
3 properties
1 required
GDS_CodesDetail
GDS_Code
object
5 properties
1 required
GDS_CodeDetail
GDS_CodeInfo
object
4 properties
1 required
GDS_Status
object
5 properties
1 required
EffectivePeriod
object
3 properties
1 required
RoomBlockInformation
object
6 properties
1 required
HotelPropertyInfo
object
8 properties
1 required
HotelDescriptiveRequestInfo
object
9 properties
1 required
HotelRequestInfo
object
5 properties
1 required
PolicyInfo
object
Used to indicate if policy information is being requested.
1 property
FacilityRequestInfo
object
3 properties
AreaInfo
object
Used to specifiy if area information is being requested.
3 properties
AffiliationInfoRequest
object
Used to indicated if affiliation information is being requested.
4 properties
DeadlineDropTime_Enum
string
An enumerated type indicating when the deadline drop time goes into effect.
MeetingRoomFormat_Enum
object
2 properties
MeetingRoomFormat_Enum_Base
string
DocumentType_Enum
object
Defines the specific type of identification or certification document.
2 properties
DocumentType_Enum_Base
string
Defines the specific type of identification or certification document.
DurationUnit_Enum
object
Defines the 'Units' that can be applied to Stay restrictions.
2 properties
DurationUnit_Enum_Base
string
Defines the 'Units' that can be applied to Stay restrictions.
BedType_Enum
object
The type(s) of sleeping option(s) in a guest accommodation.
2 properties
BedType_Enum_Base
string
The type(s) of sleeping option(s) in a guest accommodation.
GuestType_Enum
object
Category of guest.
2 properties
GuestType_Enum_Base
string
Category of guest.
LocationCategory_Enum
object
2 properties
LocationCategory_Enum_Base
string
RoomLocation_Enum
object
Specifies a hotel room location.
2 properties
RoomLocation_Enum_Base
string
Specifies a hotel room location.
BusinessService_Enum
object
Services, equipment, or supplies provided by the hotel that are generally supportive of work-related activities.
2 properties
BusinessService_Enum_Base
string
Services, equipment, or supplies provided by the hotel that are generally supportive of work-related activities.
CuisineType_Enum
object
The type of food for which the establishment is known; the style\/manner in which the food is prepared and\/or served.
2 properties
CuisineType_Enum_Base
string
The type of food for which the establishment is known; the style\/manner in which the food is prepared and\/or served.
DisabilityFeature_Enum
object
Specifies information about a facility, amenity or service that is relevant to people with a disability.
2 properties
DisabilityFeature_Enum_Base
string
Specifies information about a facility, amenity or service that is relevant to people with a disability.
RecreationService_Enum
object
Describes the recreational activities available to a guest which may or may not be operated by or located at the hotel.
2 properties
RecreationService_Enum_Base
string
Describes the recreational activities available to a guest which may or may not be operated by or located at the hotel.
SecurityFeature_Enum
object
Identifies security features of the services, meeting rooms, guest rooms, and restaurants of a property.
2 properties
SecurityFeature_Enum_Base
string
Identifies security features of the services, meeting rooms, guest rooms, and restaurants of a property.
Status_Enum
object
The status condition.
2 properties
Status_Enum_Base
string
The status condition.
ErrorWarningType_Enum
object
Tthe category of error or warning.
2 properties
ErrorWarningType_Enum_Base
string
Tthe category of error or warning.
PhoneLocation_Enum
object
Where the phone is located.
2 properties
PhoneLocation_Enum_Base
string
Where the phone is located.
PhoneUseType_Enum
object
2 properties
PhoneUseType_Enum_Base
string
PhoneTechType_Enum
object
Defines the technology associated with this phone number.
2 properties
PhoneTechType_Enum_Base
string
Defines the technology associated with this phone number.
TimeUnit_Enum
string
FeeType_Enum
object
Describes the type of fee or tax.
2 properties
FeeType_Enum_Base
string
Describes the type of fee or tax.
TravelSector_Enum
object
Specifies the travel sector.
2 properties
TravelSector_Enum_Base
string
Specifies the travel sector.
PaymentCardCode_Enum
object
The 2 digit code that identifies the credit card.
2 properties
PaymentCardCode_Enum_Base
string
The 2 digit code that identifies the credit card.
PaymentType_Enum
object
Specifies a type of payment.
2 properties
PaymentType_Enum_Base
string
Specifies a type of payment.
CommunicationLocation_Enum
object
Specifies a location for communication.
2 properties
CommunicationLocation_Enum_Base
string
Specifies a location for communication.
AddressUse_Enum
object
Describes how an address is to be used.
2 properties
AddressUse_Enum_Base
string
Describes how an address is to be used.
UnitOfMeasure_Enum
string
The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM).
EmailAddressType_Enum
object
Specifies a type of email address.
2 properties
EmailAddressType_Enum_Base
string
Specifies a type of email address.
PositionAccuracy_Enum
string
Specifies the level of accuracy for the positon.
DayOfWeek_Enum
string
Day of the Week types.
AgeQualifyingCode_Enum
object
A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Ad…
2 properties
AgeQualifyingCode_Enum_Base
string
A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Ad…
Transportation_Enum
object
Type of tranportation: Air, Rail, Bus, Boat, Private Auto, Other.
2 properties
Transportation_Enum_Base
string
Type of tranportation: Air, Rail, Bus, Boat, Private Auto, Other.
ToFrom_Enum
string
Used to indicate whether the context is to a facility or from a facility.
TaxType_Enum
object
Describes the type of fee or tax.
2 properties
TaxType_Enum_Base
string
Describes the type of fee or tax.
ChargeUnit_Enum
object
Source: Charge Type (CHG) OpenTravel codelist.
2 properties
ChargeUnit_Enum_Base
string
Source: Charge Type (CHG) OpenTravel codelist.
SegmentCategory_Enum
object
Describes the segment type.
2 properties
SegmentCategory_Enum_Base
string
Describes the segment type.
ReferencePoint_Enum
object
Specifies a point of reference.
2 properties
ReferencePoint_Enum_Base
string
Specifies a point of reference.
MealPlan_Enum
object
Different meal plans
2 properties
MealPlan_Enum_Base
string
Different meal plans
AdditionalDetailType_Enum
object
Identifies the type of detail being sent.
2 properties
AdditionalDetailType_Enum_Base
string
Identifies the type of detail being sent.
InformationType_Enum
object
Identifies the type of information being sent.
2 properties
InformationType_Enum_Base
string
Identifies the type of information being sent.
PictureCategory_Enum
object
Specifies the category of the mulitmedia item.
2 properties
PictureCategory_Enum_Base
string
Specifies the category of the mulitmedia item.
BasisType
object
Provides basis for how an amount was calculated.
2 properties
BasisType_Base
string
Provides basis for how an amount was calculated.
RoomGender_Enum
string
Frequency_Enum
object
Source: Charge Type (CHG) OpenTravel codelist.
2 properties
Frequency_Enum_Base
string
Source: Charge Type (CHG) OpenTravel codelist.
RatePlanType_Enum
object
Note: Typically used for rate plans that may be published, e.g. have no qualifying criteria, or may be restricted or negotiated, e.g. has qualifying criteria f…
2 properties
RatePlanType_Enum_Base
string
Note: Typically used for rate plans that may be published, e.g. have no qualifying criteria, or may be restricted or negotiated, e.g. has qualifying criteria f…
GuestRoomInfo_Enum
object
Identifies a property's accommodation\/inventory types for which it is useful to specify a property-level count or availability status.
2 properties
GuestRoomInfo_Enum_Base
string
Identifies a property's accommodation\/inventory types for which it is useful to specify a property-level count or availability status.
RoomViewType_Enum
object
Describes room view types
2 properties
RoomViewType_Enum_Base
string
Describes room view types
PropertyStatus_Enum
object
2 properties
PropertyStatus_Enum_Base
string
PropertyClassType_Enum
object
Used to specify the hotel property class or type.
2 properties
PropertyClassType_Enum_Base
string
Used to specify the hotel property class or type.
ArchitecturalStyle_Enum
object
Describes the architectural style of the building or room.
2 properties
ArchitecturalStyle_Enum_Base
string
Describes the architectural style of the building or room.
Proximity_Enum
object
Specifies if the item in question is onsite, offsite, nearby, etc.
2 properties
Proximity_Enum_Base
string
Specifies if the item in question is onsite, offsite, nearby, etc.
MeetingRoomCode_Enum
object
Supplies, facilities, materials, equipment available specifically for meetings and events.
2 properties
MeetingRoomCode_Enum_Base
string
Supplies, facilities, materials, equipment available specifically for meetings and events.
DiscountsAvailable_Enum
object
This is used for discounts that may be applied.
2 properties
DiscountsAvailable_Enum_Base
string
This is used for discounts that may be applied.
TemperatureUnit
string
RestaurantService_Enum
object
Type of service(s) offered by the restaurant.
2 properties
RestaurantService_Enum_Base
string
Type of service(s) offered by the restaurant.
Beverage_Enum
object
Specifies beverage types.
2 properties
Beverage_Enum_Base
string
Specifies beverage types.
AvailableMealCategory_Enum
object
The high level types of meal options available at a dining facility.
2 properties
AvailableMealCategory_Enum_Base
string
The high level types of meal options available at a dining facility.
RestaurantBarCategory_Enum
object
The type of facility in which food and\/or drink is served.
2 properties
RestaurantBarCategory_Enum_Base
string
The type of facility in which food and\/or drink is served.
RestaurantPolicy_Enum
object
Identifies rules regarding making reservations for a restaurant.
2 properties
RestaurantPolicy_Enum_Base
string
Identifies rules regarding making reservations for a restaurant.
RatingSymbol
string
Used to identify a symbol used in a rating (i.e. Diamonds, Stars).
PetsAllowed_Enum
object
Specifies if pets are allowed at a facility and at a high level the type of pets allowed.
2 properties
PetsAllowed_Enum_Base
string
Specifies if pets are allowed at a facility and at a high level the type of pets allowed.
PetPolicy_Enum
object
Specifies the types of animals allowed.
2 properties
PetPolicy_Enum_Base
string
Specifies the types of animals allowed.
AmountDetermination_Enum
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
AttractionCategory_Enum
object
Specifies a type of attraction.
2 properties
AttractionCategory_Enum_Base
string
Specifies a type of attraction.
RecreationFeatures_Enum
object
Provides further information on a recreation.
2 properties
RecreationFeatures_Enum_Base
string
Provides further information on a recreation.
ContactLocation_Enum
object
Specifies where the contact is located.
2 properties
ContactLocation_Enum_Base
string
Specifies where the contact is located.
HotelStatus_Enum
object
Describes the legal status\/operating status of a given hotel in relation to the contracting company. It may also be used to describe the system record status.
2 properties
HotelStatus_Enum_Base
string
Describes the legal status\/operating status of a given hotel in relation to the contracting company. It may also be used to describe the system record status.
PowerType_Enum
object
Types of power.
2 properties
PowerType_Enum_Base
string
Types of power.
RecycledProducts_Enum
object
Specifies products that are recycled.
2 properties
RecycledProducts_Enum_Base
string
Specifies products that are recycled.
RecyclingLocations_Enum
object
Specifies areas where recycling is implemented.
2 properties
RecyclingLocations_Enum_Base
string
Specifies areas where recycling is implemented.
DescriptiveContentID
object
4 properties
1 required
DescriptiveContent
BlackoutDates
object
5 properties
1 required
DescriptiveContentFeature
object
8 properties
1 required
MeetingRoom
object
19 properties
1 required
MeetingRoomAccessory
object
8 properties
1 required
MeetingRoomCapacity
object
4 properties
1 required
MeetingRooms
object
14 properties
1 required
AvailableCapacities
object
3 properties
1 required
Restaurants
object
5 properties
1 required
Restaurant
object
20 properties
1 required
MealsOffered
object
Indicates the meals offered at a restaurant.
4 properties
RestaurantInformation
object
2 properties
1 required
RestaurantInformationBeverage
RestaurantInformationService
RestaurantInformationAvailableMealCategory
RestaurantInformationCategory
RestaurantInformationPolicy
RestaurantInformationCuisine
Attraction
object
17 properties
1 required
AreaInformation
object
6 properties
1 required
LoyaltyProgramInformation
object
12 properties
1 required
AffiliationInfo
object
8 properties
1 required
NameType
string
OTA Code list: Name Type\tNAM\t\n\t1\tFormer\n\t2\tNickname\n\t3\tAlternate\n\t4\tMaiden
OptInStatus_Enum
string
TextFormatType
string
YesNoInherit_Enum
string
AddressBldgRoom
object
2 properties
AddressStreetNumber
object
5 properties
AmountPercent
object
4 properties
CompanyName
object
Identifies a company by name.
9 properties
Country
object
ISO 3166 code for a country.
2 properties
CurrencyCode
object
An ISO 4217 (3) alpha character code that specifies a monetary unit.
2 properties
CurrencyAmount
object
A monetary amount.
3 properties
DateTimeStamp
object
Time stamp of the creation.
6 properties
DateEffectiveExpire
object
Used to identify the effective date and\/or expiration date.
3 properties
Identifier
object
Identifier provides the ability to create a globally unique identifier. This could be GUID a UUID or any other string that an organization that distinctly iden…
4 properties
PersonName
object
6 properties
2 required
RelatedTraveler_Simple_Person_Name
object
6 properties
2 required
PersonNameDetail
RelatedTraveler_Simple_Person_NameDetail
Privacy
object
Allows for control of the sharing of data between parties.
5 properties
StateProv
object
The standard code or abbreviation for the state, province, or region.
2 properties
Telephone
object
8 properties
2 required
TelephoneDetail
Enum_TelephoneRole
object
2 properties
Enum_TelephoneRole_Base
string
Enum_TelephoneRole_Open
string
Text
object
Provides text and indicates whether it is formatted or not.
3 properties
TextParagraph
object
9 properties
1 required
Comment
object
9 properties
1 required
Description
object
9 properties
1 required
Restriction
object
9 properties
1 required
TimeSpan
object
Specifies the arrival date and departure date which covers the whole Reservation.
2 properties
2 required
URL
object
Web site address, in IETF specified format.
3 properties
ParagraphListItem
object
4 properties
DateTimeSpanWindows
object
3 properties
1 required
StayRestrictions
object
3 properties
1 required
DateTimeSpanWindowsDetail
StayRestrictionsDetail
Code
object
Any code used to specify an item, for example, type of traveler, service code, room amenity, etc. May be used to reference the OpenTravel RMA Codelist.
5 properties
PersonDocument
object
3 properties
1 required
PayloadStdAttributes
object
The standard attributes that appear on the root element for all OpenTravel messages.
12 properties
1 required
TargetEnvironment_Enum
string
TransactionStatusCode_Enum
string
ErrorWarning
object
The error in textual format.
12 properties
Geolocation
object
Used to specify the geographic coordinates of a location.
6 properties
Result
object
5 properties
1 required
Address
object
12 properties
1 required
AddressDetail
Enum_AddressRole
object
2 properties
Enum_AddressRole_Base
string
Enum_AddressRole_Open
string
Location
object
4 properties
2 required
IndexPointCode_Enum
string
Indicates the type of location being referenced (e.g., Airport, Hotel).
Email
object
9 properties
2 required
MultimediaCollection
object
4 properties
2 required
VideoCategoryID
object
4 properties
1 required
VideoCategory
MultimediaDescription
object
6 properties
2 required
MultimediaDetails
object
Warning: To be redesigned in the next release. The title of the multimedia object.
10 properties
VideoID
object
4 properties
1 required
Video
Rating
object
The actual award or rating received by the facility.
7 properties
ProcessingInfo
object
Transaction processing directives, including display currency overrides. If no display currency information is provided, the display and pricing currency will…
3 properties
OperationSchedule
object
8 properties
1 required
RateRange
object
A range of monetary values within which the cost of the available products are requested.
5 properties
LocationCode
object
Location code is city, stateProvence, or country code
5 properties
ImageID
object
4 properties
1 required
Image
ImageCategory
object
7 properties
1 required
RelativePosition
object
14 properties
1 required
Directions
object
14 properties
1 required
TransportationID
object
4 properties
1 required
Transportation
Transportations
object
3 properties
1 required
ArrivalTransport
object
3 properties
1 required
DepartureTransport
object
3 properties
1 required
TextCategory
object
6 properties
1 required
FormattedTextSubSection
object
6 properties
2 required
Amount
object
10 properties
1 required
Price
object
10 properties
1 required
AmountDetail
PriceDetail
ReferencePoint
object
6 properties
1 required
ReferencePointDetail
Dimensions
object
Defines the dimensions of an object.
5 properties
File
object
Properties of a file.
3 properties
Multimedia
object
10 properties
1 required
MultimediaImage
MultimediaText
MultimediaVideo
Tax
object
7 properties
1 required
Taxes
object
4 properties
2 required
BaseResponse
object
4 properties
1 required
FeeDetail
object
2 properties
1 required
FeeDetailAdditionalPerson
RateRangeInfo
object
4 properties
1 required
Charge
object
16 properties
1 required
Occupancy
object
4 properties
1 required
WeatherInfo
object
5 properties
1 required
Precipitation
object
Provides average precipitation and the unit in which it is measured for a Period.
2 properties
Temperature
object
3 properties
CancelPenalty
object
7 properties
1 required
CancelPenaltyDetail
UnitOfMeasure
object
4 properties
1 required
ContactInformation
object
9 properties
1 required
EnvironmentalImpact
object
13 properties
1 required
CarbonFootprint
object
8 properties
1 required
Water
object
9 properties
1 required
Energy
object
14 properties
1 required
PowerUsage
object
5 properties
1 required
Recycling
object
7 properties
1 required
Certification
object
9 properties
1 required
ExtensionPoint
ExtensionPoint_Summary
ExtensionPoint_Detail
ExtensionPoint_Custom
ExtensionPoint_Query
ExtensionPoint_Update
ExtensionPoint_Shared
ExtensionPoint_Choice
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from OpenTravel Alliance 3
Other APIs OpenTravel Alliance publishes across the network.
OpenTravel 2020A Facility Resource
OpenTravel 2018A Hospitality Offers Resource
OpenTravel 2018A Facility Resource
#Hospitality#Hotels#Content#OpenTravel 2.0
Where this information came from
This is an independent, third-party profile of OpenTravel 2020A Hotel Descriptive Content Resource, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.