The identity and technical contract details declared by the specification.
bedTypeRequestsDetails
object
Response object for fetching Bed Type Requests.
3 properties
bedTypeRequestsType
array
List of Bed Type Requests.
bedTypeRequestType
object
Contains Common Master configuration detail.
4 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
bedTypeRequestsCriteria
object
Request object for creating Bed Type Requests.
3 properties
status
object
Response Body.
2 properties
bedTypeRequestsToBeChanged
object
Request object for changing Bed Type Requests.
3 properties
bedTypesDetails
object
Response object for fetching Bed Types.
3 properties
bedTypesType
array
Bed Type Enumeration element.
bedTypeType
object
Contains Common Master configuration detail.
4 properties
bedTypesCriteria
object
Request object for creating a new Bed Type.
3 properties
bedTypesToBeChanged
object
Request object for changing an existing Bed Type.
3 properties
buildingFloorMappingsDetails
object
Response object for fetching floor mappings to buildings.
3 properties
buildingFloorMappingsType
array
Collection of Floor to Building mapping details.
buildingFloorMappingType
object
Building to Floor mapping details associated with the Hotel.
7 properties
buildingFloorMappingIDType
object
Building to Floor mapping ID details.
3 properties
setBuildingFloorMappings
object
Request object for setting floor mappings to buildings.
3 properties
buildingGroupsDetails
object
Response object after fetching Building Groups of the Hotel.
3 properties
buildingGroupsType
array
Collection of Building Group details.
buildingGroupType
object
Building or Building Group details associated with the Hotel.
8 properties
buildingGroupsCriteria
object
Request object to create Building Group details of the Hotel.
3 properties
buildingGroupsToBeChanged
object
Request object to change the Building Group details of the Hotel.
3 properties
buildingsDetails
object
Response object after fetching Building details of the Hotel.
3 properties
buildingsType
array
Collection of Building details associated with Hotel.
buildingType
object
Building or Building Group details associated with the Hotel.
9 properties
buildingsToBeChanged
object
Request object to change Building details of the Hotel.
3 properties
buildingsCriteria
object
Request object to create Building details of the Hotel.
3 properties
floorTypesDetails
object
Response object for fetching Floor Types.
3 properties
floorTypesType
array
List of Floor Types.
floorTypeType
object
Contains Common Master configuration detail.
4 properties
floorTypesCriteria
object
Request object for creating Floor Types.
3 properties
floorTypesToBeChanged
object
Request object for changing Floor Types.
3 properties
floorsDetails
object
Response object for fetching floors at the hotel level.
3 properties
hotelFloorsType
array
This type holds a collection of floors at the hotel level.
hotelFloorType
object
Base details common between both template and hotel level floors.
6 properties
floorsCriteria
object
Request object for creating floors at the hotel level.
3 properties
floorsToBeChanged
object
Request object for changing floors at the hotel level.
3 properties
validateRoomClassInUse
object
Request object to validate if room type's room class is currently in use.
4 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
housekeepingCreditRulesDetails
object
Response object for fetching housekeeping credit rules.
4 properties
housekeepingCreditRulesType
array
The information of housekeeping credit rule for configuration.
housekeepingCreditRuleType
object
The information of housekeeping credit rule for configuration.
13 properties
housekeepingCreditRuleTypeType
string
A Facility Rule will add extra credit to a task assignment sheet when certain task conditions exist. Multiple Facility Task Rules will be applied on top of eac…
housekeepingCreditRuleTravelTypeType
string
Applies to rooms across multiple section groups.
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
masterInfoType
object
2 properties
codeInfoType
object
4 properties
addtionalCodeInfoType
array
Holds name of additional code information
masterInfoCodeDetailType
string
housekeepingCreditRulesCriteria
object
Request object for creating housekeeping credit rules.
3 properties
housekeepingCreditRulesToBeChanged
object
Request object for changing housekeeping credit rules.
3 properties
housekeepingAttendantsDetails
object
Response object for fetching Housekeeping Attendants.
3 properties
housekeepingAttendantsConfigType
array
Housekeeping Attendant Information.
housekeepingAttendantType
object
Housekeeping Attendant Information.
11 properties
daysOfWeekAttrType
object
7 properties
housekeepingAttendantsCriteria
object
Add housekeeping attendant(S).
3 properties
housekeepingAttendantsToBeChanged
object
Modify housekeeping attendants
3 properties
housekeepingRoomSchedulesDetails
object
Response object for fetching housekeeping tasks and housekeeping codes associated to a room type.
3 properties
configHousekeepingRoomSchedulesType
array
This type holds a collection of housekeeping tasks attached to a room type.
configHousekeepingRoomScheduleType
object
Facility Housekeeping task code and description.
23 properties
frequencyTypeType
string
Simple type for storing frequency type.
configHousekeepingRoomScheduleTaskSuppliesType
array
This type holds a collection of housekeeping task supplies attached to a room type.
configHousekeepingRoomScheduleTaskSupplyType
object
Facility Housekeeping Code, its description and quantity.
7 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
housekeepingRoomSchedulesCriteria
object
Request object for associating housekeeping tasks and housekeeping codes to a room type.
3 properties
housekeepingRoomSchedulesToBeChanged
object
Request object for changing housekeeping tasks and housekeeping codes associated to a room type.
3 properties
housekeepingSectionGroupsDetails
object
Response object for fetching housekeeping section Groups.
3 properties
housekeepingSectionGroupsType
array
List of the housekeeping section groups to be configured or fetched
housekeepingSectionGroupType
object
Detailed information of Housekeeping Section Group.
8 properties
housekeepingSectionGroupsCriteria
object
Request object to create House Keeping Section Groups for resort.
3 properties
housekeepingSectionGroupsToBeChanged
object
Request object for modifying housekeeping section groups in resort.
3 properties
housekeepingSectionsDetails
object
Response object for fetching housekeeping section codes.
3 properties
housekeepingSectionsType
array
List of the housekeeping sections to be configured or fetched
housekeepingSectionType
object
Information regarding Housekeeping Sections.
10 properties
housekeepingSectionsCriteria
object
Add housekeeping section codes configurations for resort.
3 properties
housekeepingSectionsToBeChanged
object
Modify housekeeping section codes in resort configurations.
3 properties
housekeepingCodesDetails
object
Response object for fetching housekeeping codes.
3 properties
housekeepingCodesConfigType
array
List of the housekeeping codes to be configured or fetched
housekeepingCodeConfigType
object
Common code type for code, description
5 properties
housekeepingCodesCriteria
object
Add housekeeping codes configurations for property.
3 properties
housekeepingCodesToBeChanged
object
Modify housekeeping codes in resort configurations.
3 properties
housekeepingTaskSheetRoomsDetails
object
Response object for fetching details about housekeeping tasksheet rooms.
3 properties
housekeepingTaskSheetRoomsType
array
Collection of housekeeping room details
housekeepingTaskSheetRoomType
object
Details used for storing information about a housekeeping room
10 properties
housekeepingCreditsType
object
Information regarding the credits for housekeeping tasks/rooms.
2 properties
housekeepingCreditsDefinitionType
string
Type for the different kinds of Credits which will be used in Rooms Management.
setHousekeepingTaskSheetRooms
object
Request object for setting details about housekeeping tasksheet rooms.
3 properties
housekeepingTasksDetails
object
Response object for fetching housekeeping tasks.
3 properties
housekeepingTasksConfigType
array
List of the housekeeping tasks to be configured
housekeepingTaskConfigType
object
Common code type for code, description
13 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
housekeepingTasksCriteria
object
Add housekeeping tasks configurations for resort.
3 properties
housekeepingTasksToBeChanged
object
Modify housekeeping tasks in resort configurations.
3 properties
outOfOrderServiceReasonsDetails
object
Response object for fetching Out of Order/Service Reason(s).
9 properties
outOfOrderServiceReasonsType
array
out of order/service reason details.
outOfOrderServiceReasonType
object
Base details of the Out of order/service reason.
9 properties
outOfOrderServiceReasonsCriteria
object
Request object for creating new out of order/service reasons for hotels.
3 properties
outOfOrderServiceReasonsToBeChanged
object
Request object for modifying out of order/service reasons for hotels.
3 properties
roomGroupsDetails
object
Response object for fetching Room Groups.
3 properties
roomGroupsType
array
List of Room Pools.
roomGroupType
object
Contains Common Master configuration detail.
5 properties
roomGroupsCriteria
object
Request object for creating Room Groups.
3 properties
roomGroupsToBeChanged
object
Request object for changing Room Groups.
3 properties
roomClassesDetails
object
Response object for fetching existing hotel level room classes.
3 properties
roomClassesType
array
Collection of hotel level room classes with attached room types.
roomClassType
object
Common code type for code, description, seq and inactive
7 properties
translationTextType50
object
Contains Multiple translated texts and language codes.
2 properties
roomTypesSummaryType
object
This type holds collection of room type.
2 properties
roomTypeSummaryType
object
This type represents the summary of room type attributes.
13 properties
roomClassCriteria
object
Request object for creating a new hotel level room class.
3 properties
roomClassToBeChanged
object
Request object for changing an existing hotel level room class.
3 properties
resortRoomConditionsDetails
object
Response object for information regarding room condition configuration in a resort.
3 properties
roomCondtionsType
array
Collection of Resort Room Condition Configuration Type
roomCondtionType
object
Resort Room Condition Configuration Type
9 properties
resortRoomConditionCriteria
object
Request object for Create Room Condition.
3 properties
resortRoomConditionToBeChanged
object
Request object for Modifying Room Condition configuration in a resort.
3 properties
roomFeaturesDetails
object
Response object to fetch room features of hotel.
3 properties
roomFeaturesConfigType
array
Room feature details.
roomFeatureConfigType
object
Common code type for code, description, seq and inactive
8 properties
configHotelPreferencesType
array
This type holds a collection of preferences at the property level.
configHotelPreferenceType
object
Base details common between both template and property level preferences.
7 properties
roomFeaturesToBeChanged
object
Request object for changing room features of hotel.
3 properties
roomFeaturesCriteria
object
Request object for creating room features of hotel.
3 properties
hotelRoomMaintenanceReasonsDetails
object
Response object for fetching room maintenance reasons for a hotel.
9 properties
hotelRoomMaintenanceReasonsType
array
Details for room maintenance reason at hotel level.
hotelRoomMaintenanceReasonType
object
Base common structure for Room Maintenance at both hotel and template levels.
6 properties
hotelRoomMaintenanceReasonsCriteria
object
Request object for creating new room maintenance reasons for a hotel.
3 properties
hotelRoomMaintenanceReasonsToBeChanged
object
Request object for modifying room maintenance reasons for a hotel.
3 properties
roomTypeInfoDetails
object
Response object for fetching room type information.
3 properties
roomTypeMasterInfoType
object
The RoomType element is used to contain all the room type information for a single room type.
2 properties
roomTypeInfoType
object
20 properties
roomFeaturesType
array
A recurring element that identifies the room features.
roomFeatureType
object
Room Feature Information.
4 properties
roomTypeAttributesType
object
Attributes of property room type.
6 properties
bookingChannelMappingType
object
4 properties
bedTypeInfoType
object
Information representing Bed type associated with a room type.
2 properties
roomTypesDetails
object
Response object for Fetching existing Room Types.
10 properties
roomTypesType
object
This type holds collection of room type.
2 properties
roomTypeType
object
This type represents the room type attributes.
34 properties
roomTypeComponentsType
array
Contains room components of a component room type.
roomTypeComponentType
object
Room component and its quantity for the component room type.
3 properties
roomTypeYieldableType
string
Simple type for Yieldable or Non Yieldable
roomTypesCriteria
object
Request object for Creating a new Room Type.
3 properties
roomTypesToBeChanged
object
Request object for Modifying Room Type.
3 properties
roomsDetails
object
Response object for fetching complete information of existing rooms.
3 properties
configRoomsType
object
This type holds collection of rooms with complete information.
2 properties
configRoomType
object
This type represents the primary room attributes.
32 properties
roomTypeShortInfoType
object
Basic information of room type.
17 properties
ratePlanRatingType
string
Possible Rate plan rating values.
roomComponentsType
array
Component of a room.
roomComponentType
object
Room component and its quantity for the component room type.
4 properties
roomRoomsType
array
Collection of rooms.
roomRoomType
object
This type represents the primary room attributes.
14 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
roomSectionType
object
2 properties
roomCriteria
object
Request object for creating a new room.
3 properties
roomToBeChanged
object
Request object for changing details of an existing room.
3 properties
copyRooms
object
Request object for creating multiple rooms based on an existing room. New rooms may have different floor preferences, room features, housekeeping credits and r…
3 properties
copyRoomType
object
Primary details of room to be copied and collection of rooms to be created from it.
3 properties
copyNewRoomsType
array
Room details that may differ from the base existing room.
copyNewRoomType
object
Room details that may differ from the base existing room. If any of Floor, RoomFeatures, HousekeepingCredits and RoomSection types is not passed together with…
5 properties
copyBuildingGroups
object
Request object to copy Building Group details to hotel(s).
3 properties
copyConfigurationCodesType
array
Information needed to copy configuration code from one property to the other.
copyConfigurationCodeType
object
Information needed to copy configuration code from one property to the other.
3 properties
copyBuildings
object
Request object for copying Building details to hotel(s).
3 properties
copyHousekeepingSectionGroups
object
Request object for copying housekeeping section groups in resort.
3 properties
housekeepingSectionGroupsCopyType
array
List of the housekeeping section groups to be copied
housekeepingSectionGroupCopyType
object
Detailed information of Housekeeping Section Group to copy.
2 properties
housekeepingSectionGroupCopyInfoType
object
Detailed information of Housekeeping Section Group to copy.
3 properties
copyHousekeepingSections
object
3 properties
copyHousekeepingCodes
object
3 properties
templateOutOfOrderServiceReasonsDetails
object
Response object for fetching template Out of order/service reason(s).
3 properties
templateOutOfOrderServiceReasonsType
array
Template of out of order/service reason details.
templateOutOfOrderServiceReasonType
object
Base details of the out of order/service reason
8 properties
templateOutOfOrderServiceReasonsCriteria
object
Request object for creating new template out of order/service reasons.
3 properties
templateOutOfOrderServiceReasonsToBeChanged
object
Request object for modifying template out of order/service reasons.
3 properties
roomClassTemplateCriteria
object
Request object for creating a new room class template.
3 properties
roomClassTemplateType
object
Common code type for code, description, seq and inactive
5 properties
roomClassTemplatesDetails
object
Response object for information regarding template room classes.
3 properties
roomClassTemplatesType
array
Collection of template room classes.
roomClassTemplateToBeChanged
object
Request object for modifying an existing room class template.
3 properties
roomConditionTemplatesDetails
object
Response object for information regarding room condition template of a property.
3 properties
roomCondtionTemplatesType
array
Collection of Room Condition Template Type
roomCondtionTemplateType
object
Room Condition Template Type
7 properties
roomConditionTemplateCriteria
object
Request object for creating a new Room Condition Template.
3 properties
roomConditionTemplateToBeChanged
object
Request object for Modifying Room Condition Template.
3 properties
templateRoomFeaturesDetails
object
Response object to fetch template room features.
3 properties
templateRoomFeaturesConfigType
array
Template room feature details.
templateRoomFeatureConfigType
object
Common code type for code, description, seq and inactive
8 properties
templateRoomFeaturesCriteria
object
Request object for creating template room features.
3 properties
templateRoomFeaturesToBeChanged
object
Request object for changing template room features.
3 properties
roomHierarchiesDetails
object
Response for fetch room hierarchies
3 properties
roomHierarchiesType
array
Holds collection of room hierarchies
roomHierarchyType
object
Room Hierarchy id type for create, change and delete
6 properties
roomHierarchyTypeType
string
Provides the type of room hierarchy
roomHierarchiesCriteria
object
Request to create room hierarchies
3 properties
createRoomHierarchiesType
object
Holds collection of room hierarchies
2 properties
roomHierarchiesToBeChanged
object
Request to change room hierarchies
3 properties
copyRoomHierarchies
object
Request to copy room hierarchies
3 properties
roomHierarchiesToGenerate
object
Generates the room hierarchies based on the AI cost function
3 properties
roomHierarchySearchType
object
Room hierarchy search type to fetch room hierarchies
4 properties
templateRoomMaintenanceReasonsDetails
object
Response object for fetching template room maintenance reasons.
3 properties
templateRoomMaintenanceReasonsType
array
Details for room maintenance reason at template level.
templateRoomMaintenanceReasonType
object
Base common structure for Room Maintenance at both hotel and template levels.
5 properties
templateRoomMaintenanceReasonsCriteria
object
Request object for creating new template room maintenance reasons.
3 properties
templateRoomMaintenanceReasonsToBeChanged
object
Request object for modifying template room maintenance reasons.
3 properties
roomMoveReasonsDetails
object
Response object for fetching Room Move Reasons.
3 properties
roomMoveReasonsType
array
List of Room Move Reasons.
roomMoveReasonType
object
Contains Common Master configuration detail.
4 properties
roomMoveReasonsCriteria
object
Request object for creating Room Move Reasons.
3 properties
roomMoveReasonsToBeChanged
object
Request object for changing Room Move Reasons.
3 properties
roomPotentialsDetails
object
Response object for fetching Room Potentials.
3 properties
roomPotentialsType
array
List of Room Potentials.
roomPotentialType
object
Contains Common Master configuration detail.
5 properties
roomPotentialsCriteria
object
Request object for creating Room Potentials.
3 properties
roomPotentialsToBeChanged
object
Request object for changing Room Potentials.
3 properties
roomPreferencePrioritiesDetails
object
Response object for fetching Room Preference Priorities.
3 properties
roomPreferencePrioritiesType
array
List of Room Preference Priorities.
roomPreferencePriorityType
object
Contains Common Master configuration detail.
4 properties
roomPreferencePrioritiesCriteria
object
Request object for creating Room Preference Priorities.
3 properties
roomPreferencePrioritiesToBeChanged
object
Request object for changing Room Preference Priorities.
3 properties
roomTypeTemplatesDetails
object
Response object for information regarding room type template of a property.
10 properties
roomTypeTemplateSummaryType
array
This type holds collection of room type.
roomTypeTemplateType
array
This type holds collection of room type.
roomTypeTemplatesCriteria
object
Request object for creating a new Room Type Template.
3 properties
roomTypeTemplatesToBeChanged
object
Request object for Modifying existing Room Type Templates.
3 properties
roomsSummaryDetails
object
Response object for fetching summary information of existing rooms.
3 properties
configRoomsSummaryType
object
This type holds collection of rooms summary.
3 properties
configRoomSummaryType
object
This type represents the primary room attributes.
23 properties
smokingTypesDetails
object
Response object for fetching Smoking Types.
3 properties
smokingTypesType
array
List of Smoking Types.
smokingTypeType
object
Contains Common Master configuration detail.
4 properties
smokingTypesCriteria
object
Request object for creating Smoking Types.
3 properties
smokingTypesToBeChanged
object
Request object for changing Smoking Types.
3 properties
templateFloorsDetails
object
Response object for fetching floors at the template level.
3 properties
templateFloorsType
array
This type holds a collection of floors at the template level.
templateFloorType
object
Base details common between both template and hotel level floors.
6 properties
templateFloorsCriteria
object
Request object for creating floors at the template level.
3 properties
templateFloorsToBeChanged
object
Request object for changing floors at the template level.
3 properties
templateHousekeepingTaskConfigType
object
Common code type for template housekeeping task type.
12 properties
templateHousekeepingTasksDetails
object
Response object for fetching housekeeping tasks.
3 properties
templateHousekeepingTasksCriteria
object
Add template housekeeping tasks configurations.
3 properties
templateHousekeepingTaskToBeChanged
object
Modify housekeeping task.
3 properties
configTemplateHousekeepingRoomScheduleType
object
Type contains configuration details of the task schedules configured at template level.
22 properties
configTemplateHousekeepingRoomScheduleTaskSupplyType
object
Type to indicate associated supply codes for the template task
7 properties
templateHousekeepingRoomSchedulesDetails
object
Response object of fetch template housekeeping tasks and its associated housekeeping codes.
3 properties
templateHousekeepingRoomSchedulesCriteria
object
Request Criteria to configure housekeeping task schedules at template level.
3 properties
templateHousekeepingRoomSchedulesToBeChanged
object
Request object for changing housekeeping schedule tasks and it's associated codes configured at template level
3 properties
vacantRoomStatusesList
object
Response object for fetching vacant room statuses.
9 properties
vacantRoomStatusType
object
Information related to vacant room housekeeping status.
6 properties
vacantRoomStatusDetails
object
The request element used to create a vacant room statuses.
7 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected.
componentRoomInfoType
object
This type holds information of a Component room attached to the Component Suite.
3 properties
componentSuiteInfoType
object
This type holds information of the Component Suite to which the Component Room is attached.
3 properties
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
operaVersionNumberType
string
Current Opera Version Number
operaVersion
object
Response for Ping operation.
3 properties
generateRoomTypeDescriptionRequest
object
Request object to generate room type description with provided input.
4 properties
generateRoomTypeDescriptionResponse
object
Response object containing the generated text based on prompt input for a given use case.
4 properties
saveRoomTypeDescriptionRequest
object
Request object to save generated room type description to improve auto generation process.
1 property
saveRoomTypeDescriptionResponse
object
Response object when room type description is saved.
2 properties
searchHousekeepingAttendantsRequest
object
4 properties
deleteHousekeepingAttendantsRequest
object
14 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.