openapi: 3.2.0 info: title: Opentravel Alliance Hospitality Offers API version: 1.0.0 x-refined-note: - x-otm-library differs across the merged source definitions and was not carried description: 'Operations tagged HospitalityOffers across 2 of this provider''s published API definitions: opentravel-2018a-hospitality-offers-resource-defs-openapi.json, opentravel-2018a-hospitality-offers-resource-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: http://127.0.0.1/ tags: - name: HospitalityOffers paths: /HospitalityOffers: post: summary: HospitalityOffersResource - FindMultiPropertyOffers operationId: FindMultiPropertyOffers responses: '201': description: '' x-xml-schema: $ref: HospitalityOffers_1_0_0_Trim.xsd#/MultiPropertyHospitalityOffers content: application/json: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' '400': description: '' x-xml-schema: $ref: HospitalityOffers_1_0_0_Trim.xsd#/MultiPropertyHospitalityOffers content: application/json: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' '401': description: '' x-xml-schema: $ref: HospitalityOffers_1_0_0_Trim.xsd#/MultiPropertyHospitalityOffers content: application/json: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' '402': description: '' x-xml-schema: $ref: HospitalityOffers_1_0_0_Trim.xsd#/MultiPropertyHospitalityOffers content: application/json: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' '403': description: '' x-xml-schema: $ref: HospitalityOffers_1_0_0_Trim.xsd#/MultiPropertyHospitalityOffers content: application/json: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' '404': description: '' x-xml-schema: $ref: HospitalityOffers_1_0_0_Trim.xsd#/MultiPropertyHospitalityOffers content: application/json: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' '500': description: '' x-xml-schema: $ref: HospitalityOffers_1_0_0_Trim.xsd#/MultiPropertyHospitalityOffers content: application/json: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/MultiPropertyHospitalityOffers' requestBody: content: application/json: schema: $ref: '#/components/schemas/HospitalityOffersQueryFindHospitalityOffers' application/xml: schema: $ref: '#/components/schemas/HospitalityOffersQueryFindHospitalityOffers' required: true tags: - HospitalityOffers servers: - url: http://127.0.0.1/ components: schemas: ExtensionPoint_Summary: {} DetailedHotelSearchCriteria: x-otm-entity: EntityType: CoreObject EntityName: DetailedHotelSearchCriteria properties: '@type': type: string hotelCodeContext: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to32' examples: - context: orghs value: Sabre type: string maxLength: 32 tTIcode: description: 'Note: This code is maintained by the Travel Technology Initiative (TTI) and provides a unique way to identify a property across a multiplicity of channels, service providers, tour companies, representation companies and third parties involved in the booking, administration and fulfillment of travel within the hospitality industry. For more information: http:\/\/www.tti.org\/tticodes.html' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}positiveInteger' type: integer format: int32 Features: description: 'Assigned Type: ota2-0400:Features' $ref: '#/components/schemas/Features' BedType: description: 'Assigned Type: ota2-0300:BedType_Enum' $ref: '#/components/schemas/BedType_Enum' HotelAmenity: type: array items: $ref: '#/components/schemas/Code' maxItems: 100 RoomAmenities: type: array items: $ref: '#/components/schemas/Code' maxItems: 100 Rating: description: The minimum hotel rating value of the hotels to be returned (e.g. only return hotels with a 3.5 rating or higher). type: number format: float maximum: 5 minimum: 0 petsAllowedInd: description: When true, pets are allowed at the facility. type: boolean smokingRoomsInd: description: When true, this hotel facility offers smoking rooms. type: boolean aDACompliantInd: description: When true, this hotel facility is ADA compliant. type: boolean exactMatchInd: description: When true, only properties\/rate plans that exactly match the search criteria should be returned. type: boolean ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' ExtensionPoint_Shared: {} Promotion: x-otm-entity: EntityType: ValueWithAttributes EntityName: Promotion description: Description of the promotion. properties: value: type: string maxLength: 128 promotionVendorCode: description: 'Assigned Type: ota2-0400:ListOfTinyStrings' type: array items: type: string maxLength: 32 code: description: 'Assigned Type: ota2-0400:StringTiny' type: string maxLength: 32 name: description: 'Assigned Type: ota2-0400:StringShort' type: string maxLength: 128 TimeUnit_Enum: x-otm-entity: EntityType: EnumerationClosed EntityName: TimeUnit_Enum type: string enum: - Day - Full duration - Hour - Minute - Month - Second - Week - Year DateTimeStamp: x-otm-entity: EntityType: ValueWithAttributes EntityName: DateTimeStamp description: Time stamp of the creation. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}dateTime' properties: value: type: string format: date-time create: description: Time stamp of the creation. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}dateTime' equivalents: - context: Common value: CreateDateTime type: string format: date-time creatorID: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' equivalents: - context: Common value: CreatorID examples: - context: Common value: c123456789 type: string maxLength: 128 lastModify: description: Time stamp of last modification. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}dateTime' equivalents: - context: Common value: LastModifyDateTime type: string format: date-time lastModifierID: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' equivalents: - context: Common value: LastModifierID examples: - context: Common value: m987654321 type: string maxLength: 128 purge: description: Date an item will be purged from a database (e.g., from a live database to an archive). x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}date' equivalents: - context: Common value: PurgeDate type: string format: date RatePlanType_Enum_Base: x-otm-entity: EntityType: EnumerationOpen EntityName: RatePlanType_Enum description: '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 for eligibility and\/or has been negotiated between parties.' type: string enum: - Other_ - Weekly - Weekend - TravelIndustry - TourWholesale - SeniorCitizen - RegularRack - Published - PromotionalPackageTour - Promotional - Package - NonLastRoomAvailable - Net - Negotiated - Multi-DayPackage - Monthly - Military - LastRoomAvailable - Group - Government - FamilyPlan - DistressedInventory - DayRate - Corporate - Convention - Contract - Consortia - ClubConcierge - Association - Other_ CompanyName: x-otm-entity: EntityType: ValueWithAttributes EntityName: CompanyName description: Identifies a company by name. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength0to128' properties: value: type: string maxLength: 512 division: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' equivalents: - context: Common value: Division examples: - context: Common value: Travel Division type: string maxLength: 128 department: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' equivalents: - context: Common value: Department examples: - context: Common value: Adventure department type: string maxLength: 128 shortName: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' equivalents: - context: Common value: CompanyShortName examples: - context: Common value: Adventure Inc type: string maxLength: 128 code: description: 'Assigned Type: ota2-0400:Code' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to16' equivalents: - context: Common value: Code examples: - context: Common value: AI type: string maxLength: 32 codeContext: description: 'Assigned Type: ota2-0400:StringTiny' type: string maxLength: 32 description: description: 'Assigned Type: ota2-0400:String' type: string maxLength: 512 UnitOfMeasure_Enum: x-otm-entity: EntityType: EnumerationClosed EntityName: UnitOfMeasure_Enum description: The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM). type: string enum: - Miles - Kilometers - Meters - Millimeters - Centimeters - Yards - Feet - Inches - Pixels - Block - Megabytes - Gigabytes - Square feet - Square meters - Pounds - Kilograms - Square inch - Square yard - Acre - Square millimeter - Square centimeter - Hectare - Ounce - Gram - Gallons - Liters - Kilowatts - Cubic meters BookingChannel_Enum_Base: x-otm-entity: EntityType: EnumerationOpen EntityName: BookingChannel_Enum description: Specifies a type of booking channel. type: string enum: - Agent - Alternative distribution system (ADS) - Central reservation system (CRS) - Global distribution system (GDS) - Internet - Kiosk - Property management system (PMS) - Sales and catering system (SCS) - Tour operator system (TOS) - Other_ Status_Enum_Base: x-otm-entity: EntityType: EnumerationOpen EntityName: Status_Enum description: The status condition. type: string enum: - Complete - Incomplete - Not processed - Unknown - Other_ BookingChannel_Enum: x-otm-entity: EntityType: EnumerationOpen EntityName: BookingChannel_Enum description: Specifies a type of booking channel. properties: value: $ref: '#/components/schemas/BookingChannel_Enum_Base' extension: type: string maxLength: 128 minLength: 1 PriceModifiers: x-otm-entity: EntityType: CoreObject EntityName: PriceModifiers properties: '@type': type: string Promotion: type: array items: $ref: '#/components/schemas/Promotion' maxItems: 99 RateQualifier: type: array items: $ref: '#/components/schemas/RateQualifier' maxItems: 99 PersonIdentifier: type: array items: $ref: '#/components/schemas/PersonID' maxItems: 99 ProductRef: description: A reference to the product for which the rate modifier applies. type: string ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' BedType_Enum: x-otm-entity: EntityType: EnumerationOpen EntityName: BedType_Enum description: The type(s) of sleeping option(s) in a guest accommodation. properties: value: $ref: '#/components/schemas/BedType_Enum_Base' extension: type: string maxLength: 128 minLength: 1 RateRange: x-otm-entity: EntityType: ValueWithAttributes EntityName: RateRange description: A range of monetary values within which the cost of the available products are requested. properties: minRate: description: 'Assigned Type: ota2-0400:Money' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}Money' type: number format: float maxRate: description: 'Assigned Type: ota2-0400:Money' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}Money' type: number format: float fixedRate: description: 'Assigned Type: ota2-0400:Money' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}Money' type: number format: float rateTimeUnit: description: Used to specify the period of time to which the rates apply. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}TimeUnitType' $ref: '#/components/schemas/TimeUnit_Enum' currencyCode: description: 'Assigned Type: ota2-0400:CurrencyCode_ISO4217' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}AlphaLength3' type: string pattern: '[a-zA-Z]{3}' ErrorWarningType_Enum_Base: x-otm-entity: EntityType: EnumerationOpen EntityName: ErrorWarningType_Enum description: Tthe category of error or warning. type: string enum: - Advisory - Application error - Authentication - Authentication timeout - Authorization - Business rule - No implementation - Processing exception - Protocol violation - Required field missing - Unknown - Other_ ProductQueriesHospitality: x-otm-entity: EntityType: ChoiceObject EntityName: ProductQueries allOf: - $ref: '#/components/schemas/ProductQueries' - properties: RoomStayQueryProduct: description: 'Assigned Type: prod-0400:RoomStay_Query_Product' $ref: '#/components/schemas/RoomStayQueryProduct' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' LoyaltyProgram: x-otm-entity: EntityType: CoreObject EntityName: LoyaltyProgram x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength0to32' - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength0to32' properties: '@type': type: string id: description: 'Assigned Type: ota2-0400:StringShort' type: string maxLength: 128 loyaltyLevel: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to16' equivalents: - context: Common value: LoyaltyLevel examples: - context: Common value: Platinum type: string maxLength: 32 ProgramCode: description: 'Assigned Type: ota2-0400:Code' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to16' equivalents: - context: Common value: ProgramCode $ref: '#/components/schemas/Code' TravelSector: description: 'Assigned Type: ota2-0300:TravelSector_Enum' $ref: '#/components/schemas/TravelSector_Enum' primaryInd: description: When true, indicates this is the primary loyalty program and when absent or false, indicates this is not the primary loyalty program. type: boolean ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' RateQualifier: x-otm-entity: EntityType: ValueWithAttributes EntityName: RateQualifier description: Name of the rate qualifier properties: value: type: string maxLength: 128 code: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'AttributeGroup: RateQualifierCoreGroup' type: string maxLength: 32 rateAuthorizationCode: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' type: string maxLength: 32 rateID: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' type: string maxLength: 32 ratePeriod: description: The RatePeriod attribute defines the type of rate that may be applied. For example, typically car rental rates differ based upon the duration of the rental, and the actual rate is then expressed in terms of the period of the rental. x-otm-annotations: documentation: implementers: - 'LocalAnonymousType: RateQualifierCoreGroup_RatePeriod' $ref: '#/components/schemas/RatePeriod_Enum' description: description: 'Assigned Type: ota2-0400:StringLong' type: string maxLength: 4096 HospitalityOffersID: x-otm-entity: EntityType: BusinessObject EntityName: HospitalityOffers properties: '@type': type: string objID: description: A unique identifier within this document for this object. type: string Identifier: description: 'Assigned Type: ota2-0400:Identifier' $ref: '#/components/schemas/Identifier' HospitalityOffersRef: description: Refers to the obj ID on an object defined elsewhere in the current document. type: string required: - '@type' discriminator: propertyName: '@type' Status_Enum: x-otm-entity: EntityType: EnumerationOpen EntityName: Status_Enum description: The status condition. properties: value: $ref: '#/components/schemas/Status_Enum_Base' extension: type: string maxLength: 128 minLength: 1 Code: x-otm-entity: EntityType: ValueWithAttributes EntityName: Code description: 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. properties: value: type: string maxLength: 32 codeContext: description: 'Assigned Type: ota2-0400:StringTiny' type: string maxLength: 32 description: description: 'Assigned Type: ota2-0400:String' type: string maxLength: 512 BasePayload: x-otm-entity: EntityType: CoreObject EntityName: BasePayload properties: '@type': type: string PayloadStdAttributes: description: 'Assigned Type: ota2-0400:PayloadStdAttributes' $ref: '#/components/schemas/PayloadStdAttributes' POS: description: 'Assigned Type: ota2-0400:POS' $ref: '#/components/schemas/POS' ProcessingInfo: description: 'Assigned Type: ota2-0400:ProcessingInfo' $ref: '#/components/schemas/ProcessingInfo' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' Geolocation: x-otm-entity: EntityType: ValueWithAttributes EntityName: Geolocation description: TODO-(use enums and other for lat,long?? Format for the lat and long, is there a XML format)Used to specify the geographic coordinates of a location. properties: latitude: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to16' equivalents: - context: Common value: Latitude type: string maxLength: 32 longitude: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to16' equivalents: - context: Common value: Longitude type: string maxLength: 32 altitude: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to16' equivalents: - context: Common value: Altitude type: string maxLength: 32 altitudeUnitOfMeasure_Enum: description: Provides the unit of measure for the altitude (e.g., feet, meters, miles, kilometers). Refer to OpenTravel Code List Unit of Measure Code (UOM). x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}OTA_CodeType' equivalents: - context: Common value: AltitudeUnitOfMeasureCode $ref: '#/components/schemas/UnitOfMeasure_Enum' mapURL: description: The URL of a map image. type: string formatURL: description: The URL to the format for the latitude and longitude for this location. type: string POS: x-otm-entity: EntityType: CoreObject EntityName: POS properties: '@type': type: string Source: type: array items: $ref: '#/components/schemas/Source' maxItems: 10 minItems: 1 ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' - Source discriminator: propertyName: '@type' Text: x-otm-entity: EntityType: ValueWithAttributes EntityName: Text description: Provides text and indicates whether it is formatted or not. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}string' properties: value: type: string maxLength: 4096 language: description: The language in which the text is provided. x-otm-annotations: documentation: implementers: - 'AttributeGroup: LanguageGroup' examples: - context: Common value: en type: string textFormat: description: Indicates the format of text used in the description e.g. unformatted or html. x-otm-annotations: documentation: implementers: - 'LocalAnonymousType: FormattedTextTextType_TextFormat' equivalents: - context: Common value: TextFormat examples: - context: Common value: Sample Formatted text $ref: '#/components/schemas/TextFormatType' ErrorWarning: x-otm-entity: EntityType: ValueWithAttributes EntityName: ErrorWarning description: The error in textual format. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to64' properties: value: type: string maxLength: 512 language: description: 'Assigned Type: ota2-0400:LanguageCode' type: string type: $ref: '#/components/schemas/ErrorWarningType_Enum_Base' typeExtension: type: string maxLength: 128 minLength: 1 shortText: description: 'Assigned Type: ota2-0400:StringShort' type: string maxLength: 128 code: description: 'Assigned Type: ota2-0400:OTA_Code' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}OTA_CodeType' equivalents: - context: Common value: Code type: string pattern: '[0-9A-Z]{1,4}(\.[A-Z]{3}(\.X){0,1}){0,1}' docURL: description: If present, this URL refers to an online description of the error that occurred. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}anyURI' equivalents: - context: Common value: DocURL type: string tag: description: 'Assigned Type: ota2-0400:String' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}string' equivalents: - context: Common value: Tag type: string maxLength: 512 recordID: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to64' equivalents: - context: Common value: RecordID type: string maxLength: 128 nodeList: description: 'Assigned Type: ota2-0400:String' type: string maxLength: 512 status: $ref: '#/components/schemas/Status_Enum_Base' statusExtension: type: string maxLength: 128 minLength: 1 ImageID: x-otm-entity: EntityType: BusinessObject EntityName: Image description: 'Warning: This will be redesigned in the next release.' x-otm-annotations: documentation: implementers: - 'Extension: VideoItemType' properties: '@type': type: string objID: description: A unique identifier within this document for this object. type: string Identifier: description: 'Assigned Type: ota2-0400:Identifier' $ref: '#/components/schemas/Identifier' ImageRef: description: Refers to the obj ID on an object defined elsewhere in the current document. type: string required: - '@type' discriminator: propertyName: '@type' PersonID: x-otm-entity: EntityType: BusinessObject EntityName: Person properties: '@type': type: string objID: description: A unique identifier within this document for this object. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}RPH_Type' equivalents: - context: Common value: RPH type: string Identifier: description: 'Assigned Type: ota2-0400:Identifier' $ref: '#/components/schemas/Identifier' OtherID: type: array items: $ref: '#/components/schemas/Identifier' maxItems: 5 PersonRef: description: Refers to the obj ID on an object defined elsewhere in the current document. type: string required: - '@type' - Identifier discriminator: propertyName: '@type' ExtensionPoint: {} BasicPropertyInfo: x-otm-entity: EntityType: CoreObject EntityName: BasicPropertyInfo description: Identifies a property. properties: '@type': type: string code: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: examples: - context: ph value: WASJW type: string maxLength: 32 ExtensionPoint_Summary: $ref: '#/components/schemas/ExtensionPoint_Summary' required: - '@type' discriminator: propertyName: '@type' BookingChannel: x-otm-entity: EntityType: CoreObject EntityName: BookingChannel properties: '@type': type: string CompanyName: description: 'Assigned Type: ota2-0400:CompanyName' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}CompanyNameType' equivalents: - context: Common value: CompanyName $ref: '#/components/schemas/CompanyName' Type: description: 'Assigned Type: ota2-0300:BookingChannel_Enum' $ref: '#/components/schemas/BookingChannel_Enum' primaryInd: description: Indicates whether the enumerated booking channel is the primary means of connectivity used by the source. type: boolean ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' MultiPropertyHospitalityOffers: x-otm-entity: EntityType: CoreObject EntityName: BaseResponse properties: '@type': type: string HospitalityOffers: type: array items: $ref: '#/components/schemas/HospitalityOffersID' PayloadStdAttributes: description: 'Assigned Type: ota2-0400:PayloadStdAttributes' $ref: '#/components/schemas/PayloadStdAttributes' Result: description: 'Assigned Type: ota2-0400:Result' $ref: '#/components/schemas/Result' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' ParagraphListItem: x-otm-entity: EntityType: ValueWithAttributes EntityName: ParagraphListItem properties: listItem: description: The item or sequence number. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}integer' equivalents: - context: Common value: ListItem type: integer format: int32 text2: description: 'Assigned Type: ota2-0400:Text' type: string maxLength: 4096 language: description: The language in which the text is provided. x-otm-annotations: documentation: implementers: - 'AttributeGroup: LanguageGroup' examples: - context: Common value: en type: string textFormat: description: Indicates the format of text used in the description e.g. unformatted or html. x-otm-annotations: documentation: implementers: - 'LocalAnonymousType: FormattedTextTextType_TextFormat' equivalents: - context: Common value: TextFormat examples: - context: Common value: Sample Formatted text $ref: '#/components/schemas/TextFormatType' TextFormatType: x-otm-entity: EntityType: EnumerationClosed EntityName: TextFormatType type: string enum: - PlainText - HTML Identifier: x-otm-entity: EntityType: ValueWithAttributes EntityName: Identifier description: 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 identifies the specific object.\n\nIdeally, for the identifier to be globally unique it must have a system provided identifier and the system must be identified using a global naming authority. System identification uses the domain naming system (DNS) to assure they are globally unique and should be an URL. The system provided ID will typically be a primary or surrogate key in a database.\n\nThe URL, system and company attributes can be omitted only when the system context can be implied by a parent or ancestor element. properties: value: type: string maxLength: 128 url: description: Uri of the creating system. The URI should be an URL and be globally unique. Should only be omitted when the context is clearly implied for the containing document. x-otm-annotations: documentation: implementers: - Identifier provides the ability to create a globally unique identifier. For the identifier to be globally unique it must have a system provided identifier and the system must be identified using a global naming authority. System identification uses the domain naming system (DNS) to assure they are globally unique and should be an URL. The system provided ID will typically be a primary or surrogate key in a database. type: string system: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: examples: - context: Common value: sysABC3344 type: string maxLength: 128 organization: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: examples: - context: Common value: Acme type: string maxLength: 128 TargetEnvironment_Enum: x-otm-entity: EntityType: EnumerationClosed EntityName: TargetEnvironment_Enum type: string enum: - Test - Production ProductQueries: x-otm-entity: EntityType: ChoiceObject EntityName: ProductQueries properties: '@type': type: string PriceModifiers: description: 'Assigned Type: order-0300:PriceModifiers' $ref: '#/components/schemas/PriceModifiers' LoyaltyProgram: description: 'Assigned Type: ota2-0400:LoyaltyProgram' $ref: '#/components/schemas/LoyaltyProgram' ExtensionPoint_Shared: $ref: '#/components/schemas/ExtensionPoint_Shared' required: - '@type' discriminator: propertyName: '@type' Result: x-otm-entity: EntityType: CoreObject EntityName: Result properties: '@type': type: string Errors: type: array items: $ref: '#/components/schemas/ErrorWarning' maxItems: 50 Warnings: type: array items: $ref: '#/components/schemas/ErrorWarning' maxItems: 50 Status: description: 'Assigned Type: ota2-0300:Status_Enum' $ref: '#/components/schemas/Status_Enum' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' Source: x-otm-entity: EntityType: CoreObject EntityName: Source properties: '@type': type: string agentSine: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to16' equivalents: - context: Common value: AgentSine type: string maxLength: 32 pseudoCityCode: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to16' equivalents: - context: Common value: PseudoCityCode type: string maxLength: 32 iSOCountry: description: 'Assigned Type: ota2-0400:CountryCode_ISO3166' x-otm-annotations: documentation: references: - http:\/\/simple.wikipedia.org\/wiki\/ISO_3166-1_alpha-3 implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}ISO3166' equivalents: - context: Common value: ISOCountry type: string pattern: '[a-zA-Z]{2}' iSOCurrency: description: 'Assigned Type: ota2-0400:CurrencyCode_ISO4217' x-otm-annotations: documentation: references: - http:\/\/www.iso.org\/iso\/support\/currency_codes_list-1.htm implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}AlphaLength3' equivalents: - context: Common value: ISOCurrency type: string pattern: '[a-zA-Z]{3}' agentDutyCode: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to16' equivalents: - context: Common value: AgentDutyCode type: string maxLength: 32 airlineVendorID: description: 'Assigned Type: ota2-0400:AirlineCode_IATA' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}UpperCaseAlphaNumericLength2to3' equivalents: - context: Common value: AirlineVendorID examples: - context: Common value: B6 type: string pattern: ([a-zA-Z0-9]{2})? airportCode: description: 'Assigned Type: ota2-0400:AirportCode_IATA' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}UpperCaseAlphaNumericLength3to5' equivalents: - context: Common value: AirportCode examples: - context: Common value: IAD type: string pattern: ([A-Z]{3})? firstDepartPoint: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength3' equivalents: - context: Common value: FirstDepartPoint type: string maxLength: 32 eRSP_UserID: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to16' equivalents: - context: Common value: ERSP_UserID type: string maxLength: 32 terminalID: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to32' equivalents: - context: Common value: TerminalID type: string maxLength: 32 RequestorID: description: 'Assigned Type: ota2-0400:RequestorID' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}RequestorID' equivalents: - context: Common value: RequestorID $ref: '#/components/schemas/RequestorID' Position: description: 'Assigned Type: ota2-0400:Geolocation' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}Position' equivalents: - context: Common value: Position $ref: '#/components/schemas/Geolocation' BookingChannel: description: 'Assigned Type: ota2-0400:BookingChannel' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}BookingChannel' equivalents: - context: Common value: BookingChannel $ref: '#/components/schemas/BookingChannel' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' TimeSpan: x-otm-entity: EntityType: ValueWithAttributes EntityName: TimeSpan description: Specifies the arrival date and departure date which covers the whole Reservation. properties: start: description: 'Assigned Type: ota2-0400:DateTime' x-otm-annotations: examples: - context: Common value: '2016-08-22T19:32:52Z' type: string format: date-time end: description: 'Assigned Type: ota2-0400:DateTime' x-otm-annotations: examples: - context: Common value: '2016-08-28T04:32:52Z' type: string format: date-time required: - start - end TravelSector_Enum_Base: x-otm-entity: EntityType: EnumerationOpen EntityName: TravelSector_Enum description: Specifies the travel sector. type: string enum: - Air - Car - Cruise - Excursion - Ferry - Golf - Hotel - Insurance - Package option - Rail - Tour - Other_ RatePeriod_Enum: x-otm-entity: EntityType: EnumerationClosed EntityName: RatePeriod_Enum description: The RatePeriodSimpleType simple type defines a set of valid values for the type of rate that may be applied. Typically rates differ based upon the duration, and the actual rate is then expressed in terms of the period of the rental. type: string enum: - Hourly - Daily - Weekly - Monthly - WeekendDay - Other - Package - Bundle - Total RoomStayQueryProduct: x-otm-entity: EntityType: BusinessObject EntityName: RoomStay description: Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally finacial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. properties: '@type': type: string BasicPropertyInfo: description: 'Assigned Type: ph:BasicPropertyInfo' $ref: '#/components/schemas/BasicPropertyInfo' BaseHospitalityFacilityQuery: description: 'Assigned Type: orghs-0300:BaseHospitalityFacilityQuery' $ref: '#/components/schemas/BaseHospitalityFacilityQuery' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' BedType_Enum_Base: x-otm-entity: EntityType: EnumerationOpen EntityName: BedType_Enum description: The type(s) of sleeping option(s) in a guest accommodation. type: string enum: - Dorm bed - Double/full - Futon - King - Murphy bed - Queen - Run of the house - Sofa bed - Tatami mats - Twin/single - Water bed - Other_ HospitalityOffersQueryFindHospitalityOffers: x-otm-entity: EntityType: BusinessObject EntityName: HospitalityOffers properties: '@type': type: string BasePayload: description: 'Assigned Type: ota2-0400:BasePayload' $ref: '#/components/schemas/BasePayload' ProductQueriesHospitality: description: 'Assigned Type: ph:ProductQueries_Hospitality' $ref: '#/components/schemas/ProductQueriesHospitality' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' ProcessingInfo: x-otm-entity: EntityType: ValueWithAttributes EntityName: ProcessingInfo description: Transaction processing directives, including display currency overrides. If no display currency information is provided, the display and pricing currency will default to the value in POS\/Source\/@ISOCurrency. x-otm-annotations: documentation: implementers: - (Developer Notes) An agreement should be in place with your trading partners that specifies what information is summary versus detail. properties: displayCurrency: description: 'Assigned Type: ota2-0400:CurrencyCode_ISO4217' x-otm-annotations: documentation: references: - '(Reference): http:\/\/www.opentraveldevelopersnetwork.com\/Supported_ISO_Standards.php' more-info: - '(More Info): http:\/\/www.opentraveldevelopersnetwork.com\/2012A_SchemaDoc\/DisplayCurrency' type: string pattern: '[a-zA-Z]{3}' positiveInteger: description: The maximum quantity of search results in the response. type: integer format: int32 summaryResultsInd: description: If true, summary information is requested in the search results. type: boolean TravelSector_Enum: x-otm-entity: EntityType: EnumerationOpen EntityName: TravelSector_Enum description: Specifies the travel sector. properties: value: $ref: '#/components/schemas/TravelSector_Enum_Base' extension: type: string maxLength: 128 minLength: 1 Description: x-otm-entity: EntityType: CoreObject EntityName: TextParagraph properties: '@type': type: string name: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/chameleon.anonymous\/ns}StringLength1to64' equivalents: - context: Common value: Name examples: - context: Common value: paragraph name type: string maxLength: 32 number: description: The sequence number for the paragraph. x-otm-annotations: documentation: implementers: - Changed type from {http:\/\/www.w3.org\/2001\/XMLSchema}nonNegativeInteger. - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}string' equivalents: - context: Common value: ParagraphNumber type: integer format: int32 Text: type: array items: $ref: '#/components/schemas/Text' maxItems: 1000 Image: type: array items: $ref: '#/components/schemas/ImageID' maxItems: 1000 URL: type: array items: type: string maxItems: 1000 ParagraphListItem: type: array items: $ref: '#/components/schemas/ParagraphListItem' maxItems: 1000 DateTimeStamp: description: 'Assigned Type: ota2-0400:DateTimeStamp' x-otm-annotations: documentation: implementers: - 'AttributeGroup: DateTimeStampGroup' $ref: '#/components/schemas/DateTimeStamp' ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' discriminator: propertyName: '@type' RatePlanCode: x-otm-entity: EntityType: ValueWithAttributes EntityName: RatePlanCode description: A string value may be used to request a particular code or an ID if the guest qualifies for a specific rate, such as AARP, AAA, a corporate rate, etc., or to specify a negotiated code as a result of a negotiated rate. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to64' properties: value: type: string maxLength: 128 ratePlanType: $ref: '#/components/schemas/RatePlanType_Enum_Base' ratePlanTypeExtension: type: string maxLength: 128 minLength: 1 ratePlanID: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to64' equivalents: - context: ph value: RatePlanID examples: - context: ph value: '12345678' type: string maxLength: 128 ratePlanCategory: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to64' equivalents: - context: ph value: RatePlanCategory examples: - context: ph value: POD type: string maxLength: 128 promotionCode: description: 'Assigned Type: ota2-0400:StringTiny' x-otm-annotations: examples: - context: ph value: L9Z type: string maxLength: 32 promotionVendorCode: description: 'Assigned Type: ota2-0400:ListOfTinyStrings' x-otm-annotations: examples: - context: ph value: WT1 type: array items: type: string maxLength: 32 ratePlanQualifierInd: description: The Rate Plan Qualifier is used to control the sort order of RatePlans. Those Rate Plans that are not qualified will appear first, those that are qualified will appear last. type: boolean BaseHospitalityFacilityQuery: x-otm-entity: EntityType: CoreObject EntityName: BaseHospitalityFacilityQuery properties: '@type': type: string numberOfRooms: description: 1The number of rooms being queried for. x-otm-annotations: examples: - context: orghs value: '1' type: integer format: int32 DateTimeSpan: description: 'Assigned Type: ota2-0400:TimeSpan' $ref: '#/components/schemas/TimeSpan' GuestCount: type: array items: $ref: '#/components/schemas/GuestCount' maxItems: 99 RateRange: description: 'Assigned Type: ota2-0400:RateRange' $ref: '#/components/schemas/RateRange' DetailedHotelSearchCriteria: description: 'Assigned Type: orghs-0300:DetailedHotelSearchCriteria' $ref: '#/components/schemas/DetailedHotelSearchCriteria' RoomTypeCode: type: array items: $ref: '#/components/schemas/Code' maxItems: 100 RatePlanCode: type: array items: $ref: '#/components/schemas/RatePlanCode' maxItems: 100 ExtensionPoint: $ref: '#/components/schemas/ExtensionPoint' required: - '@type' - DateTimeSpan discriminator: propertyName: '@type' GuestCount: x-otm-entity: EntityType: ValueWithAttributes EntityName: GuestCount description: Identifies the number of guests for the reservation. properties: value: type: integer format: int32 ageQualifyingCode: description: 'Assigned Type: ota2-0400:StringTiny' type: string maxLength: 32 age: description: Specifies the specific age of the guest. type: integer format: int32 Features: x-otm-entity: EntityType: ChoiceObject EntityName: Features properties: '@type': type: string quantity: description: 'Assigned Type: ota2-0400:NonNegativeInteger' type: integer format: int32 minimum: 0 Description: description: 'Assigned Type: ota2-0400:Description' $ref: '#/components/schemas/Description' ExtensionPoint_Shared: $ref: '#/components/schemas/ExtensionPoint_Shared' required: - '@type' discriminator: propertyName: '@type' TransactionStatusCode_Enum: x-otm-entity: EntityType: EnumerationClosed EntityName: TransactionStatusCode_Enum type: string enum: - Start - End - Rollback - InSeries - Continuation - Subsequent RequestorID: x-otm-entity: EntityType: CoreObject EntityName: RequestorID description: An identifier of the entity making the request (e.g. ATA\/IATA\/ID number, Electronic Reservation Service Provider (ERSP), Association of British Travel Agents.(ABTA)). x-otm-annotations: documentation: implementers: - 'Extension: UniqueID_Type' properties: '@type': type: string Identifier: description: 'Assigned Type: ota2-0400:Identifier' $ref: '#/components/schemas/Identifier' ExtensionPoint_Summary: $ref: '#/components/schemas/ExtensionPoint_Summary' required: - '@type' discriminator: propertyName: '@type' PayloadStdAttributes: x-otm-entity: EntityType: ValueWithAttributes EntityName: PayloadStdAttributes description: The standard attributes that appear on the root element for all OpenTravel messages. properties: echoToken: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to128' equivalents: - context: Common value: EchoToken type: string maxLength: 128 timeStamp: description: YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock:\n20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}dateTime' equivalents: - context: Common value: TimeStamp type: string format: date-time target: description: Test or Production target system indicator. x-otm-annotations: documentation: implementers: - 'LocalAnonymousType: OTA_PayloadStdAttributes_Target' equivalents: - context: Common value: Target $ref: '#/components/schemas/TargetEnvironment_Enum' targetName: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to64' equivalents: - context: Common value: TargetName type: string maxLength: 128 version: description: The OpenTravel message version indicated by a decimal value. x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}decimal' equivalents: - context: Common value: Version type: number format: float transactionIdentifier: description: Unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction). x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}string' equivalents: - context: Common value: TransactionIdentifier type: string sequenceNmbr: description: 'Implementer: Message resynchronization typically is required if a system has been off-line and needs to retrieve messages that were missed.' x-otm-annotations: documentation: implementers: - Changed type from {http:\/\/www.w3.org\/2001\/XMLSchema}nonNegativeInteger. - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}string' equivalents: - context: Common value: SequenceNmbr type: string transactionStatusCode: description: This indicates where this message falls within a sequence of messages. x-otm-annotations: documentation: implementers: - 'LocalAnonymousType: OTA_PayloadStdAttributes_TransactionStatusCode' equivalents: - context: Common value: TransactionStatusCode $ref: '#/components/schemas/TransactionStatusCode_Enum' correlationID: description: 'Assigned Type: ota2-0400:StringShort' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}StringLength1to64' equivalents: - context: Common value: CorrelationID type: string maxLength: 128 primaryLangID: description: 'ISO 639 (3) character language codes: http:\/\/en.wikipedia.org\/wiki\/Lists_of_ISO_639_codes' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}language' equivalents: - context: Common value: PrimaryLangID examples: - context: Common value: en type: string altLangID: description: 'ISO 639 (3) character language codes: http:\/\/en.wikipedia.org\/wiki\/Lists_of_ISO_639_codes' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}language' equivalents: - context: Common value: AltLangID examples: - context: Common value: es type: string retransmissionIndicatorInd: description: 'Implementer: It is recommended that this attribute is used (i.e., set to TRUE) only when a message is retransmitted.' x-otm-annotations: documentation: implementers: - 'Assigned XSD Type: {http:\/\/www.w3.org\/2001\/XMLSchema}boolean' equivalents: - context: Common value: RetransmissionIndicator type: boolean required: - version x-refined-from: - opentravel-2018a-hospitality-offers-resource-defs-openapi.json - opentravel-2018a-hospitality-offers-resource-openapi.json x-otm-resource: namespace: http://www.opentravel.org/OTM/resources/HospitalityResources/v1 localName: FacilityResource