OperationId:postSubAllocation
" }, { "info": { "name": "Get the Block activity log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blockActivityLog", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code." }, { "name": "module", "value": "", "type": "query", "description": "Activity module." }, { "name": "moduleParamsParameterName", "value": "", "type": "query", "description": "Name of the parameter." }, { "name": "moduleParamsParameterValue", "value": "", "type": "query", "description": "Value of the parameter." }, { "name": "activityGroup", "value": "", "type": "query" }, { "name": "activityType", "value": "", "type": "query" }, { "name": "activityParamsFromDate", "value": "", "type": "query", "description": "Search from date for the user activity log." }, { "name": "activityParamsToDate", "value": "", "type": "query", "description": "Search to date for the user activity log." }, { "name": "activityParamsSearchText", "value": "", "type": "query", "description": "Search text for the user activity log." }, { "name": "userByIDsUserId", "value": "", "type": "query" }, { "name": "userForIDsUserId", "value": "", "type": "query" } ] }, "docs": "Use this API to facilitate retrieving the block activity log.OperationId:getBlockActivityLog
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get Block Wash Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blockWash", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "blockId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "genericRoomType", "value": "", "type": "query", "description": "Indicates if the Allocation objects refer to Generic Room Types (Room Pools)." } ] }, "docs": "This API retrieves block information needed to perform block wash operation.OperationId:getBlockWashInfo
" }, { "info": { "name": "Update Block Allocation Wash", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blockWash", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API removes block allocation to a range of dates for a set of room types.OperationId:putBlockAllocationWash
" }, { "info": { "name": "Get Blocks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query" }, { "name": "markAsRecentlyAccessed", "value": "", "type": "query", "description": "Mark this block as recently accessed." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "multipleHotelsSearchHotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "superSearch", "value": "", "type": "query", "description": "Free form text field for searching block fields" }, { "name": "blockIdList", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "externalReferenceIds", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "externalSystemCodes", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "blockCode", "value": "", "type": "query", "description": "Block code" }, { "name": "blockName", "value": "", "type": "query", "description": "Block Name" }, { "name": "blockOwner", "value": "", "type": "query", "description": "Block Owner." }, { "name": "blockStatus", "value": "", "type": "query", "description": "Block Status." }, { "name": "cateringStatus", "value": "", "type": "query", "description": "Catering Status." }, { "name": "reservationMethod", "value": "", "type": "query", "description": "Mode of reservation (e.g. EML, TEL, FRTDSK )." }, { "name": "createdByUser", "value": "", "type": "query", "description": "user who created the Block(s)." }, { "name": "blockStartEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "blockStartStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "blockEndEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "blockEndStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "reservationArrival", "value": "", "type": "query", "description": "Date when guests plan to arrive(first night stay date)." }, { "name": "reservationDeparture", "value": "", "type": "query", "description": "Date when guests plan to leave(last stay day date)." }, { "name": "includeShoulderDates", "value": "", "type": "query", "description": "Whether to include shoulder dates when considering stay date." }, { "name": "stayDate", "value": "", "type": "query" }, { "name": "blockCreatedOnEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "blockCreatedOnStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "decisionEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "decisionStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "cutOffEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "cutOffStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "category", "value": "", "type": "query", "description": "Simple type for block instructions to be used in requests for fetching blocks. Valid status values are Group, Source, TravelAgent, Contact, Company." }, { "name": "name", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "attachedProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "attachedProfileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "leads", "value": "", "type": "query", "description": "Show Leads in the search result." }, { "name": "tourSeries", "value": "", "type": "query", "description": "Show tour series in the search result." }, { "name": "onlyPickupBlocks", "value": "", "type": "query", "description": "Fetch only blocks which are open for pickup, if true. If the value is false, fetch all block statuses." }, { "name": "onlyOpportunities", "value": "", "type": "query", "description": "Indicates that only Opportunity blocks will be fetched." }, { "name": "excludeMasterBlocks", "value": "", "type": "query", "description": "Indicates that all master blocks will be excluded from the results. (Master Blocks, Master Allocations, Master Tours, and Master Itineraries)." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate Plan Code." }, { "name": "tourCode", "value": "", "type": "query", "description": "Tour code for the block." }, { "name": "attributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" }, { "name": "returnEligibleMasterAllocations", "value": "", "type": "query", "description": "Return only master allocations that are eligible to be the master for the business block to be converted to sub allocation specified in `targetSubAllocationBlockId`." }, { "name": "targetSubAllocationBlockId", "value": "", "type": "query", "description": "The ID of the regular business block that is being converted to sub allocation." }, { "name": "returnEligibleMasterTours", "value": "", "type": "query", "description": "Return only master tours or master itineraries that are eligible to be the master for the business block being converted to either a sub tour or a sub itinerary." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Type for block instructions that can be used in requests for partial operations." }, { "name": "fetchAllocatedRoomTypes", "value": "", "type": "query", "description": "Indicates whether to fetch only those room types that have rooms allocated. If this flag is true then only those room types with rooms allocated for the block are fetched. Only applicable to fetch instruction RateGrid." }, { "name": "additionalCriteriaStartDate", "value": "", "type": "query", "description": "Start Date for the rate grid data. Only applicable to fetch instruction RateGrid." }, { "name": "numberOfDays", "value": "", "type": "query", "description": "Number of days to fetch for the rate grid data. Only applicable to fetch instruction RateGrid." }, { "name": "adults", "value": "", "type": "query", "description": "Defines the number of Adults." }, { "name": "children", "value": "", "type": "query", "description": "Defines the number of Children." }, { "name": "childAge", "value": "", "type": "query", "description": "Age of a child in years." }, { "name": "bucket1Count", "value": "", "type": "query", "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1)." }, { "name": "bucket2Count", "value": "", "type": "query", "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2)." }, { "name": "bucket3Count", "value": "", "type": "query", "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3)." }, { "name": "bucket4Count", "value": "", "type": "query", "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4)." }, { "name": "bucket5Count", "value": "", "type": "query", "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5)." }, { "name": "existingReservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "existingReservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "roomAllocationCriteria", "value": "", "type": "query", "description": "Simple type for block allocation used in room rate grid." }, { "name": "roomType", "value": "", "type": "query", "description": "The Room Types that need to be fetched for the rate room grid data. If these values are not provided, all room types for the block will be fetched." }, { "name": "additionalCriteriaRatePlanCode", "value": "", "type": "query", "description": "Rate Plan to use for fetching rates." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Curency in which the grid rates should be fetched." }, { "name": "accessRestriction", "value": "", "type": "query", "description": "Simple type for block access exclusion/restriction types." }, { "name": "cateringOnly", "value": "", "type": "query", "description": "Filter blocks which are marked as Catering only. Only Catering only blocks are returned when true." }, { "name": "marketCode", "value": "", "type": "query", "description": "Filter blocks based on market code, If not provided all the blocks will be returned." }, { "name": "sourceCode", "value": "", "type": "query", "description": "Filter blocks based on source code, If not provided all the blocks will be returned." } ] }, "docs": "Use this API to retrieve a list of blocks for requested query parameters. A wide range of query parameters is available to support various persona requirements, so it is recommended to include, at least, the hotel block date range, stay date range, and/or number of days as query parameters. You can use more query parameters to narrow your results. This API is not designed to support sync between two systems or initial upload of data. If x-hubid is used as a header, it returns matching data from " }, { "info": { "name": "Validate Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/actions/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to validate if block rate code has overlapping blocks and also validates and creates block details.OperationId:postBlockValidate
" }, { "info": { "name": "Get Block Daily Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/dailyStatistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "genericRoomType", "value": "", "type": "query", "description": "Indicates if the Allocation objects refer to Generic Room Types (Room Pools)." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelId", "value": "", "type": "query", "description": "Pertain Hotel Code for search criteria." }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." } ] }, "docs": "Use this API to retrieve block daily statistics for the given date range and hotel ID.OperationId:getBlockDailyStatistics
The maximum allowable limit for this API is 31.
This API allows a time span of 90 days.
" }, { "info": { "name": "Search Blocks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to retrieve a list of blocks for requested query parameters. A wide range of query parameters is available to support various persona requirements, so it is recommended to include, at least, the hotel block date range, stay date range, and/or number of days as query parameters. You can use more query parameters to narrow your results. This API is not designed to support sync between two systems or initial upload of data. If x-hubid is used as a header, it returns matching data from " }, { "info": { "name": "Get Next Block Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "currentStatus", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "includeCateringStatus", "value": "", "type": "query", "description": "Flag to include catering next status." } ] }, "docs": "Use this API to retrieve next set of statuses and their next statuses for the current status passed in the request.OperationId:getNextBlockStatus
" }, { "info": { "name": "Validate Block Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockCode/actions/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockCode", "value": "", "type": "path", "description": "Block code" } ] }, "docs": "This API validates the block code for the following if applicable - Unique block code/ Start of inventory week/ Block code template.OperationId:putValidateBlockCode
" }, { "info": { "name": "Create alternate dates for a Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/:blockId/alternateDates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to create alternate dates for a block.OperationId:postAlternateDates
" }, { "info": { "name": "Change alternate dates for a Block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/alternateDates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to change alternate dates for a block.OperationId:putAlternateDates
" }, { "info": { "name": "Delete alternate dates for a Block", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/blocks/:blockId/alternateDates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to delete alternate dates for a block.OperationId:deleteAlternateDates
" }, { "info": { "name": "Get Block Attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/attachments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code." }, { "name": "attachedFileName", "value": "", "type": "query", "description": "File name used to filter final list of attachments. For example, Document.txt." }, { "name": "description", "value": "", "type": "query", "description": "Description used to filter final list of attachments. For example, Offical guest ID. (This parameter does not require wildcard characters like * or % )." } ] }, "docs": "Use this API to retrieve block attachments.OperationId:getBlockAttachments
" }, { "info": { "name": "Delete Block Attachment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/blocks/:blockId/attachments/:attachId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "attachId", "value": "", "type": "path", "description": "Attachment Id" }, { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API remove block attachments.OperationId:deleteBlockAttachment
" }, { "info": { "name": "Set Block Exclusion information", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/blockAccessExclusion", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Us this API to create/change block access exclusion information.OperationId:putBlockAccessExclusion
" }, { "info": { "name": "Delete Block access exclusion", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/blocks/:blockId/blockAccessExclusion", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "allowCancelReservation", "value": "", "type": "query", "description": "Allow to cancel a reservation under this access exclusion." }, { "name": "allowCreateReservation", "value": "", "type": "query", "description": "Allow to create a reservation under this access exclusion." }, { "name": "allowModifyReservation", "value": "", "type": "query", "description": "Allow to modify a reservation under this access exclusion." }, { "name": "excludeFromAvailability", "value": "", "type": "query", "description": "Exclude a specific rate from availability" }, { "name": "inactive", "value": "", "type": "query", "description": "The rate access exclusion is inactive" }, { "name": "sourceType", "value": "", "type": "query", "description": "The type of source (CRO or Hotel code) for which the rate access exclusion is set." }, { "name": "sourceValue", "value": "", "type": "query", "description": "CRO or Hotel code value." }, { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." } ] }, "docs": "Use this API to delete block access exclusionOperationId:deleteBlockAccessExclusion
" }, { "info": { "name": "Block Cut Off", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/blockCutOff", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "This API cuts off block allocation effective current date.OperationId:putBlockCutoff
" }, { "info": { "name": "Get Block owners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/owners", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code of the business block." } ] }, "docs": "Use this API to retrieve block owners.OperationId:getBlockOwners
" }, { "info": { "name": "Assign a Block owner", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/:blockId/owners", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to assign block owners.OperationId:postBlockOwners
" }, { "info": { "name": "Change Block owners", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/owners", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to change block owners.OperationId:putBlockOwners
" }, { "info": { "name": "Delete a Block owner", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/blocks/:blockId/owners", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to delete a block owner.OperationId:deleteBlockOwners
" }, { "info": { "name": "Refreshes Block rates", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to refreshes block rates.OperationId:putBlockRates
" }, { "info": { "name": "Retrieves all reservations created for the Block", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/reservations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code to which the block belongs to." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction." } ] }, "docs": "Use this API to retrieve all reservations created for the given block ID.OperationId:getBlockReservations
" }, { "info": { "name": "Change Block reservations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/reservations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to make changes to block reservations.OperationId:putBlockReservations
" }, { "info": { "name": "Get Block restrictions ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/restrictions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code to which the block belongs to." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type for the restriction." } ] }, "docs": "This API retrieves block restrictions.OperationId:getBlockRestrictions
This API allows a time span of 90 days.
" }, { "info": { "name": "Create Block Restriction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/:blockId/restrictions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to create block restrictions.OperationId:postBlockRestriction
" }, { "info": { "name": "Clear-All Block Restrictions ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/restrictions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "This API clears all block restrictions for a given date.OperationId:putClearAllRestrictions
" }, { "info": { "name": "Delete Block Restriction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/blocks/:blockId/restrictions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel to which the block belongs to." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "code", "value": "", "type": "query" }, { "name": "roomTypes", "value": "", "type": "query", "description": "Room Type for the restriction." } ] }, "docs": "Use this API to delete block restrictions.OperationId:deleteBlockRestriction
This API allows a time span of 90 days.
" }, { "info": { "name": "Fetch Block Revenue Changes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/revenueActivityLog", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code for this block." }, { "name": "status", "value": "", "type": "query", "description": "Status of this block." }, { "name": "changeEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "changeStartDate", "value": "", "type": "query", "description": "The starting value of the date range." } ] }, "docs": "This API will fetch revenue changes for a specific block recorded in the revenue change log for a specified date range. Please note that the revenue changes are delta changes only and single records do not represent a total summary of the block revenue per date.OperationId:getBlockRevenueChanges
The maximum allowable limit for this API is 200.
This API allows a time span of 30 days.
" }, { "info": { "name": "Set room type order for a Block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/roomTypeOrder", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to set room type order for a block.OperationId:putRoomTypeOrder
" }, { "info": { "name": "Get Bock Room Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/roomTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "fetchAllocatedRoomTypes", "value": "", "type": "query", "description": "Indicates whether to fetch only allocated room types for the block." }, { "name": "startDate", "value": "", "type": "query", "description": "The start date of the range to be used to fetch allocated room types." }, { "name": "endDate", "value": "", "type": "query", "description": "The end date of the range to be used to fetch allocated room types." }, { "name": "fetchGenericRoomTypes", "value": "", "type": "query", "description": "Indicates to fetch Generic Room Types (Room Pools)." } ] }, "docs": "Use this API to retrieve room types for a block based on search criteriaOperationId:getBlockRoomTypes
This API allows a time span of 30 days.
" }, { "info": { "name": "Create Block Rooming List Reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/:blockId/roomingList", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to create a Reservation Rooming List.OperationId:postRoomingList
" }, { "info": { "name": "Get room status for a Block", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/roomsStatus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." } ] }, "docs": "This API facilitates retrieving room status for the block.OperationId:getBlockRoomsStatus
" }, { "info": { "name": "Get Block Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/statistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code of the business block." }, { "name": "startDate", "value": "", "type": "query", "description": "Start date for the statistics data." }, { "name": "numberOfDays", "value": "", "type": "query", "description": "Number of days to fetch for statistics data." }, { "name": "statisticsInstructions", "value": "", "type": "query", "description": "Type of statistic for which its statistics information by date and room type will be populated." }, { "name": "roomTypeHotelId", "value": "", "type": "query" }, { "name": "invBlockCode", "value": "", "type": "query", "description": "Block code." }, { "name": "promotionCode", "value": "", "type": "query", "description": "Represents the promotional code." }, { "name": "roomCategory", "value": "", "type": "query" }, { "name": "roomClass", "value": "", "type": "query" }, { "name": "roomQualifierCode", "value": "", "type": "query", "description": "Represents the room qualifier code like Deluxe,Economy,Suite etc." }, { "name": "roomQualifierMatchIndicator", "value": "", "type": "query", "description": "Represents the match indicator of room qualifier code returned in the response with the requested room qualifier code." }, { "name": "roomType", "value": "", "type": "query" }, { "name": "roomViewCode", "value": "", "type": "query", "description": "Represents the room view code like City view, River view, Ocean view etc." }, { "name": "roomFeatureCode", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "defaultOccupancy", "value": "", "type": "query", "description": "Default occupancy of property room type." }, { "name": "maximumOccupancy", "value": "", "type": "query", "description": "Max occupancy of property room type." }, { "name": "noOfPhysicalRooms", "value": "", "type": "query", "description": "Number of physical rooms of property room type." }, { "name": "bookingChannelCode", "value": "", "type": "query" }, { "name": "bookingChannelMappingCode", "value": "", "type": "query" }, { "name": "bookingChannelMappingName", "value": "", "type": "query" }, { "name": "bedTypeCode", "value": "", "type": "query", "description": "Bed type code associated with room." } ] }, "docs": "Use this API to API retrieve detailed block statisticsOperationId:getBlockStatistics
" }, { "info": { "name": "Get Block Status Activity Log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/statusActivityLog", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code for this block ." }, { "name": "changeEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "changeStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "currentStatus", "value": "", "type": "query", "description": "Current Status of the block ." } ] }, "docs": "Use this API to retrieve block status change log based on the HotelCode and Block ID.OperationId:getBlockStatusChanges
The maximum allowable limit for this API is 200.
This API allows a time span of 30 days.
" }, { "info": { "name": "Create a Block tour series", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/:blockId/tourSeries", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to create a block tour series.OperationId:postTourSeries
" }, { "info": { "name": "Validate Block tour series", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/tourSeries/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to validate block tour series.OperationId:putTourSeriesValidate
" }, { "info": { "name": "Get Block Wash Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/:blockId/washSchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." } ] }, "docs": "Use this API to retrieve the information regarding block wash schedule based on the parameter HotelCode and Block ID.OperationId:getBlockWashSchedules
" }, { "info": { "name": "Create Block Wash Schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/:blockId/washSchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "This API creates new block wash schedules based on Wash Date, Room Type, Occupancy detail, Sell limit and Wash by percent value.OperationId:postBlockWashSchedules
" }, { "info": { "name": "Change Block Wash Schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/blocks/:blockId/washSchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "This API changes block wash schedules Wash Date, Room Type, Occupancy detail, Sell limit and Wash by percent value.OperationId:putBlockWashSchedules
" }, { "info": { "name": "Remove Block Wash Schedules", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/blocks/:blockId/washSchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to remove block wash schedules based on the HotelCode, Block ID and Wash Date.OperationId:deleteBlockWashSchedules
" }, { "info": { "name": "Copy a Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/blocks/:sourceBlockId/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "sourceBlockId", "value": "", "type": "path", "description": "Source Block Id" } ] }, "docs": "Use this API to copy the a block. The block copied (Source block) will serve as a template for the new one.OperationId:postCopyBlock
" }, { "info": { "name": "Change Catering Status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/caterings/:eventId/cateringStatus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "eventId", "value": "", "type": "path", "description": "Event Id" } ] }, "docs": "Use this API to update catering status.OperationId:putCateringStatus
" }, { "info": { "name": "Get Central Sales Hotels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/centralSalesHotels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "countryCode", "value": "", "type": "query", "description": "Code for a country or a nationality (e.g. SW, USA, IN). This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/Countries" }, { "name": "marketingRegionCode", "value": "", "type": "query", "description": "Marketing Region Code where the given cities are located. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/MarketingRegions" }, { "name": "marketingCity", "value": "", "type": "query", "description": "Marketing City where the properties are located. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/MarketingCityTemplates" }, { "name": "propertyTypeCode", "value": "", "type": "query", "description": "Property Type to filter the search result. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/HotelTypes" }, { "name": "amenityCode", "value": "", "type": "query", "description": "Amenity Code to filter the search result. This is configured at template level and can be retrieved via /lov/{version}/listOfValues/TemplateAmenityCodes" }, { "name": "attractionCode", "value": "", "type": "query", "description": "Attraction Code to filter the search result. This is configured at template level and can be retrieved via /lov/{version}/listOfValues/TemplateAmenityCodes" }, { "name": "centralLeadHasCatering", "value": "", "type": "query", "description": "Indicates whether central lead has catering or not" }, { "name": "includeOnlyCentralResorts", "value": "", "type": "query", "description": "Indicates whether to include only central resorts." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." } ] }, "docs": "Use this API to return central sales hotel configuration information based on central lead, search criteria such as country, marketing region etc.OperationId:getCentralSalesHotels
" }, { "info": { "name": "Set Contract Defaults", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/contractDefaults", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to set the contract defaults.OperationId:putContractDefaults
" }, { "info": { "name": "Get default Block Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/defaultBlockCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "blockName", "value": "", "type": "query", "description": "Used for Character Strings, length 0 to 2000." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date of the business block." }, { "name": "blockCodeTemplate", "value": "", "type": "query", "description": "Used for Character Strings, length 0 to 2000." } ] }, "docs": "Use this API to retrieve a default block code based on template.OperationId:getDefaultBlockCode
" }, { "info": { "name": "Create default Block Code for Multiple blocks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/defaultBlockCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to create the default block code for multiple blocks based on the pattern for the Block Code Template OPERA Control.OperationId:postDefaultBlockCode
" }, { "info": { "name": "Create a Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/block", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to create a new block catered to block related functionality in OPERA Cloud. You must first use the ListOfValues APIs to find block attributes, such as Block Status, Room Types, and so on. Knowing this list of values helps ensure a successful postBlock.OperationId:postBlock
" }, { "info": { "name": "Get Block Revenue for a given date.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blockDailyRevenue", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" }, { "name": "statisticsDate", "value": "", "type": "query", "description": "Date for which statistics is required." }, { "name": "blockStatus", "value": "", "type": "query", "description": "Status Code for the business Blocks and Events." }, { "name": "ownerCode", "value": "", "type": "query", "description": "Owner Code" }, { "name": "blockDailyRevenueCategory", "value": "", "type": "query", "description": "A collection of supported list of revenue category for Block Daily Revenue." }, { "name": "revenueType", "value": "", "type": "query", "description": "List of Selected Revenue Types" }, { "name": "revenueGroup", "value": "", "type": "query", "description": "List of Selected Revenue Groups" } ] }, "docs": "You can use this API to retrieve block revenue for a given date.OperationId:getBlockDailyRevenue
" }, { "info": { "name": "Get modified blocks from a specific time period in OPERA.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/changesByDateTime", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "startLastModifiedDate", "value": "", "type": "query", "description": "From Change Date / Time when block was modified." }, { "name": "endLastModifiedDate", "value": "", "type": "query", "description": "To Change Date / Time when block was modified." }, { "name": "blockStatus", "value": "", "type": "query", "description": "Status of the block that was modified." }, { "name": "openForPickup", "value": "", "type": "query", "description": "Indicates if modified blocks are open for pickup or not." }, { "name": "cateringOnly", "value": "", "type": "query", "description": "Indicates if modified blocks are only for catering." }, { "name": "includeEventChanges", "value": "", "type": "query", "description": "Indicates if event changes for block are to be included." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." } ] }, "docs": "A user can search for blocks that have been created, updated and/or deleted within maximum 3 day date range. If in the time period searched a block was created and deleted, the query won't return this information. If a block is created and updated, the create information is returned. If a block is updated only, it returns the update. If a block is updated and delete, it returns the delete.The maximum allowable limit for this API is 1000.
This API allows a time span of" }, { "info": { "name": "Get a Block By ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "markAsRecentlyAccessed", "value": "", "type": "query", "description": "Mark this block as recently accessed." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Type for block instructions that can be used in requests for partial operations." }, { "name": "fetchAllocatedRoomTypes", "value": "", "type": "query", "description": "Indicates whether to fetch only those room types that have rooms or rates allocated. If this flag is true then only those room types with rooms or rates allocated for the block are fetched. Only applicable to fetch instruction RateGrid." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date for the rate grid data. Only applicable to fetch instruction RateGrid." }, { "name": "numberOfDays", "value": "", "type": "query", "description": "Number of days to fetch for the rate grid data. Only applicable to fetch instruction RateGrid. If this query parameter is not provided, the API defaults to returning data for 7 days." }, { "name": "roomAllocationCriteria", "value": "", "type": "query", "description": "Simple type for block allocation used in room rate grid." }, { "name": "roomTypes", "value": "", "type": "query", "description": "The Room Types that need to be fetched for the rate room grid data. If these values are not provided, all room types for the block will be fetched." }, { "name": "fetchRoomTypesWithInventory", "value": "", "type": "query", "description": "Indicates whether to fetch only those room types that have rooms allocated. If this flag is true then only those room types with rooms allocated for the block are fetched. Only applicable to fetch instruction RateGrid." } ] }, "docs": "Use this API to retrieve a specific block. You will need to know the blockID in the request; if you don't know it, please go ahead and use getBlocks API first. The response will include detailed information about the block.
OperationId:getBlock
" }, { "info": { "name": "Change a Block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to update an existing group block in OPERA Cloud. This API allows update of block header information, such as description, market segment, source code, rate code, and other details, but does not include updates for room grid or events, which have their own update API calls.OperationId:putBlock
" }, { "info": { "name": "Delete a Block", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to delete block, if any reservations attached to the block, you will be unable to delete.OperationId:deleteBlock
" }, { "info": { "name": "Set Block Allocation ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/allocation", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to add block room type allocations and rates to a specified Block.OperationId:putBlockAllocation
" }, { "info": { "name": "Get Block Range Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/allocationRange", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "genericRoomType", "value": "", "type": "query", "description": "Indicates if the Allocation objects refer to Generic Room Types (Room Pools)." } ] }, "docs": "Request for updating block allocation for a range of dates.OperationId:getBlockRangeInfo
" }, { "info": { "name": "Set Block Allocation Range", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/allocationRange", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to set block allocation for a range of dates for a list of room types.OperationId:putBlockAllocationRange
" }, { "info": { "name": "Get Block AvailaBility", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/availability", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "overrideRateCode", "value": "", "type": "query" }, { "name": "arrivalDate", "value": "", "type": "query", "description": "Arrival date." }, { "name": "nights", "value": "", "type": "query", "description": "Number of nights of stay." }, { "name": "adults", "value": "", "type": "query", "description": "Number of Adults." }, { "name": "children", "value": "", "type": "query", "description": "Number of Children." }, { "name": "childAge", "value": "", "type": "query", "description": "Age of a child in years." }, { "name": "bucket1Count", "value": "", "type": "query", "description": "Number of children classified under the first Age Qualifying Group (Child Bucket #1)." }, { "name": "bucket2Count", "value": "", "type": "query", "description": "Number of children classified under the second Age Qualifying Group (Child Bucket #2)." }, { "name": "bucket3Count", "value": "", "type": "query", "description": "Number of children classified under the third Age Qualifying Group (Child Bucket #3)." }, { "name": "bucket4Count", "value": "", "type": "query", "description": "Number of children classified under the fourth Age Qualifying Group (Child Bucket #4)." }, { "name": "bucket5Count", "value": "", "type": "query", "description": "Number of children classified under the fifth Age Qualifying Group (Child Bucket #5)." }, { "name": "rooms", "value": "", "type": "query", "description": "Number of Rooms" }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate Plan Code" }, { "name": "existingReservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "existingReservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "roomType", "value": "", "type": "query", "description": "Room type." }, { "name": "fetchAllocatedRoomType", "value": "", "type": "query", "description": "Instruction to determine room types to fetch." }, { "name": "roomTypeCount", "value": "", "type": "query", "description": "Criteria to fetch number of room type(s)." }, { "name": "detailedAvailability", "value": "", "type": "query", "description": "Indicates if Detailed Availability will be returned." } ] }, "docs": "Use this API to search for availability on an OPERA block. You will need to know the block ID. Once you know what rooms and rates are available you can proceed to post a block reservation.OperationId:getBlockAvailability
" }, { "info": { "name": "Cancel the Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/cancellations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to complete a cancellation of the block.OperationId:postCancelBlock
" }, { "info": { "name": "Recalculate Catering Revenue", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/cateringRevenue", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "blockId", "value": "", "type": "path", "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." } ] }, "docs": "Use this API to recalculate catering revenue for the business block.OperationId:putCateringRevenue
" }, { "info": { "name": "Get exchange interfaces from business block", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/exchangeInterfaces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Customers are able to retrieve the external systems to which a block is sending business events to." }, { "info": { "name": "Set exchange interfaces for business block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/exchangeInterfaces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "Use this API to set exchange interfaces configured for a particular business block." }, { "info": { "name": "Change Block status to Open", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/openStatus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to transition booking status in allotment header to an Open for Pickup Status, which ready to receive reservation bookings.OperationId:putBlockStatusToOpen
" }, { "info": { "name": "Create Block posting master", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/postingMaster", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to create a new posting Master reservation against a block in OPERA. The block status in OPERA needs to be 'Open for Pick up' to successfully post a BlockPostingMaster reservation.OperationId:postBlockPostingMaster
" }, { "info": { "name": "Get Posting Master Reservations for a Block", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/postingMaster/reservations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "postingmaster", "value": "", "type": "query", "description": "If true, a PM reservation will be created for the block if no PM reservations exist." } ] }, "docs": "Use this API to retrieve PM (Posting Master) reservations for a block.OperationId:getBlockPMReservations
" }, { "info": { "name": "Change rate override", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/rate/override", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to change rate override.OperationId:changeRateOverride
" }, { "info": { "name": "Use this API to convert a regular block to a master block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/regularToMasterBlock/:masterBlockCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "masterBlockCode", "value": "", "type": "path", "description": "The block code of the master block to be created" } ] }, "docs": "This API converts a regular block to a master block. The regular block is converted to a sub block with its room grid and events (if any on the original) and a master block is created with the same information as in the original block, except room grid and events.OperationId:putRegularToMasterBlock
" }, { "info": { "name": "Convert a regular business block to a sub allocation under a master allocation in the same property.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/regularToSubAllocation/:masterAllocationId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "masterAllocationId", "value": "", "type": "path", "description": "Master Allocation Id" } ] }, "docs": "This API converts a regular business block into a sub allocation, associating it with a specified master allocation identified by `masterAllocationId` within the same property. Note that this conversion is only applicable to master and sub allocations.OperationId:putRegularToSubAllocation
" }, { "info": { "name": "Convert a regular block to a sub tour or sub itinerary under a master tour or master itinerary.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/regularToSubTour/tourHotels/:masterTourHotelId/tours/:masterTourId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "masterTourHotelId", "value": "", "type": "path", "description": "Master Tour Hotel Id" }, { "name": "masterTourId", "value": "", "type": "path", "description": "Master Tour Id" } ] }, "docs": "This API converts a regular block to a sub tour or sub itinerary by linking it to a master tour or master itinerary. For tours, the master and its subs must be in the same property. For itineraries, the master and its subs can be in different properties.OperationId:putRegularToSubTour
" }, { "info": { "name": "Operation to get room rate grid for a Block and supports pagination.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/roomRateGrid", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "fetchAllocatedRoomTypes", "value": "", "type": "query", "description": "Indicates whether to fetch only those room types that have rooms allocated. If this flag is true then only those room types with rooms allocated for the block are fetched. Only applicable to fetch instruction RateGrid." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date for the rate grid data. Only applicable to fetch instruction RateGrid." }, { "name": "numberOfDays", "value": "", "type": "query", "description": "Number of days to fetch for the rate grid data. Only applicable to fetch instruction RateGrid." }, { "name": "roomAllocationCriteria", "value": "", "type": "query", "description": "Simple type for block allocation used in room rate grid." }, { "name": "roomTypes", "value": "", "type": "query", "description": "The Room Types that need to be fetched for the rate room grid data. If these values are not provided, all room types for the block will be fetched." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested." } ] }, "docs": "Use this API to retrieve grid details for a specific block. The response will include detailed information about the block grid and response can be paginated for blocks with longer date range..OperationId:getBlockRoomRateGrid
" }, { "info": { "name": "Shifts the Block start date", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/shifts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to move or shift the dates of a block in OPERA.OperationId:putBlockShift
" }, { "info": { "name": "Change the Status of a Block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this to change the status of a block in Opera. To know a hotels Block status codes, use the List Of Values API - BlockStatuses. Also note, you can only change the status in a particular order, for example INQ to DEF, but not DEF to INQ.OperationId:putBlockStatus
" }, { "info": { "name": "Use this API to convert a sub block to a regular block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/subBlockToRegular", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "blockId", "value": "", "type": "path", "description": "Block Id" } ] }, "docs": "This API converts a sub block to a regular block. If this is the only sub block for its master block, then the master block becomes a regular block as well.OperationId:putSubBlockToRegular
" }, { "info": { "name": "Create a sub-Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/subBlocks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this when you want to create a sub block.You will need to know the OPERA Block ID, which you want this sub block to fall under.OperationId:postSubBlock
" }, { "info": { "name": "Remove Block Wash Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/washSchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockId", "value": "", "type": "path", "description": "Block Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "washDate", "value": "", "type": "query", "description": "Block Wash Date" } ] }, "docs": "Use this API to remove block wash schedule based on the HotelCode, Block ID and Wash Date.OperationId:deleteBlockWashSchedule
" }, { "info": { "name": "Get a Block By ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/blocks/:blockExternalId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockExternalId", "value": "", "type": "path", "description": "External Block ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "markAsRecentlyAccessed", "value": "", "type": "query", "description": "Mark this block as recently accessed." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Type for block instructions that can be used in requests for partial operations." }, { "name": "fetchAllocatedRoomTypes", "value": "", "type": "query", "description": "Indicates whether to fetch only those room types that have rooms allocated. If this flag is true then only those room types with rooms allocated for the block are fetched. Only applicable to fetch instruction RateGrid." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date for the rate grid data. Only applicable to fetch instruction RateGrid." }, { "name": "numberOfDays", "value": "", "type": "query", "description": "Number of days to fetch for the rate grid data. Only applicable to fetch instruction RateGrid." }, { "name": "roomAllocationCriteria", "value": "", "type": "query", "description": "Simple type for block allocation used in room rate grid." }, { "name": "roomTypes", "value": "", "type": "query", "description": "The Room Types that need to be fetched for the rate room grid data. If these values are not provided, all room types for the block will be fetched." } ] }, "docs": "Use this API to retrieve a specific block. You will need to know the blockID in the request; if you don't know it, please go ahead and use getBlocks API first. The response will include detailed information about the block.OperationId:getBlockByExtId
" }, { "info": { "name": "Change a Block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/blocks/:blockExternalId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockExternalId", "value": "", "type": "path", "description": "External Block Id" }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "You can use this API to update an existing block. You must know the block ID for the request message. Use getBlocks if you dont already know the block ID.OperationId:putBlockByExtId
" }, { "info": { "name": "Set Block Allocation ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/blocks/:blockExternalId/allocation/roomTypes/:roomType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomType", "value": "", "type": "path", "description": "Room Type" }, { "name": "blockExternalId", "value": "", "type": "path", "description": "External Block Id" }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to add block room type allocations and rates to a specified Block.OperationId:putBlockAllocationByExtId
" }, { "info": { "name": "Set Block Allocation Range", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/blocks/:blockExternalId/allocationRange", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockExternalId", "value": "", "type": "path", "description": "External Block Id" }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this API to set block allocation for a range of dates for a list of room types.OperationId:putBlockAllocationRangeByExtId
" }, { "info": { "name": "Get Posting Master Reservations for a Block", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/blocks/:blockExternalId/postingMaster/reservations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockExternalId", "value": "", "type": "path", "description": "External Block Id" }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" }, { "name": "postingmaster", "value": "", "type": "query", "description": "If true, a PM reservation will be created for the block if no PM reservations exist." } ] }, "docs": "Use this API to retrieve PM (Posting Master) reservations for a block.OperationId:getBlockPMReservationsByExtId
" }, { "info": { "name": "Change the Status of a Block", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/blocks/:blockExternalId/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockExternalId", "value": "", "type": "path", "description": "External Block Id" }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "HotelId" } ] }, "docs": "Use this to change the status of a block in Opera. To know a hotels Block status codes, use the List Of Values API - BlockStatuses. Also note, you can only change the status in a particular order, for example INQ to DEF, but not DEF to INQ.OperationId:putBlockStatusByExtId
" }, { "info": { "name": "Create a sub-Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/blocks/:blockExternalId/subBlocks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "blockExternalId", "value": "", "type": "path", "description": "External Block Id" }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Id" } ] }, "docs": "Use this when you want to create a sub block.You will need to know the OPERA Block ID, which you want this sub block to fall under.OperationId:postSubBlockByExtId
" }, { "info": { "name": "Use this API to create Property Leads", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/leads/:leadId/propertyLeads", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Central Hotel Id" }, { "name": "leadId", "value": "", "type": "path", "description": "Central Lead Id" } ] }, "docs": "You would use this request to create property leads for the properties provided. You will need to know the Central Lead ID, which you want the property leads to fall under.OperationId:createPropertyLeads
" }, { "info": { "name": "Get Traces By Date Range", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/tracesByDateRange", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "beginDate", "value": "", "type": "query", "description": "Begin date for fetching traces criteria." }, { "name": "endDate", "value": "", "type": "query", "description": "End date for fetching traces criteria." }, { "name": "department", "value": "", "type": "query", "description": "Department for which traces are to be fetched." } ] }, "docs": "You can use this API to get traces for Reservations and Blocks.OperationId:getTracesByDateRange
This API allows a time span of 90 days.
" }, { "info": { "name": "Borrow Inventory", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/inventory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to borrow inventory from the block or house when you encounter an insufficient number of rooms for block a reservation.OperationId:putInventory
" }, { "info": { "name": "Return Borrowed Inventory", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/inventoryReleased", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to return the previously borrowed inventory on the block back to the original source from which it was borrowed. The original source can be a room type or house inventory, as indicated in the request.OperationId:putReleasedInventory
" }, { "info": { "name": "Get inventory to Borrow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/inventoryToBorrow", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "blockId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "requiredRooms", "value": "", "type": "query", "description": "The number of rooms that need to be borrowed." }, { "name": "blockIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "existingReservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "existingReservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "roomType", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "numberOfRooms", "value": "", "type": "query", "description": "The number of rooms associated with the reservation." }, { "name": "borrowDate", "value": "", "type": "query", "description": "The date on which rooms need to be borrowed for the block." }, { "name": "overrideRateCode", "value": "", "type": "query", "description": "Flag to override the inclusion of block rate code as a criteria when deciding what room types can be allowed to borrow." }, { "name": "overrideRestriction", "value": "", "type": "query", "description": "Flag indicating whether to override any restrictions that exist on the rate or room type." } ] }, "docs": "Use this API to retrieve borrowable inventory for the requested dates when encountering an insufficient number of rooms in a block for a specific room type, or for overall inventory. This operations would usually be used when attempting to pick up a reservation against a block, and the block inventory does not have enough rooms left to support the reservation pick up.OperationId:getInventoryToBorrow
This API allows a time span of 30 days.
" }, { "info": { "name": "Get recently accessed Blocks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/recentlyAccessedBlocks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API retrieves recently accessed blocks.OperationId:getRecentlyAccessedBlocks
" }, { "info": { "name": "Get Sales allowances", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/salesAllowances", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ceilingId", "value": "", "type": "query", "description": "ID of sales allowance." } ] }, "docs": "Use this API to retrieve the Sales Allowance of max amount of rooms that can be sold.OperationId:getSalesAllowances
" }, { "info": { "name": "This API retrieves the Block service version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/block/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to ping and retrieve block service status.OperationId:pingBlockService
" } ] }, { "info": { "name": "BlockStats", "type": "folder" }, "items": [ { "info": { "name": "Get Block statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/blocks/statistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Property context of the request." }, { "name": "reportCode", "value": "", "type": "query", "description": "Supported Housekeeping report codes." }, { "name": "reportEndDate", "value": "", "type": "query", "description": "End date of the report." }, { "name": "reportStartDate", "value": "", "type": "query", "description": "Start date of the report." }, { "name": "statisticalCode", "value": "", "type": "query", "description": "Supported housekeeping statistical codes." }, { "name": "reportParametersParameterName", "value": "", "type": "query", "description": "Name of the parameter." }, { "name": "reportParametersParameterValue", "value": "", "type": "query", "description": "Value of the parameter." }, { "name": "blockOwnersCode", "value": "", "type": "query", "description": "Supported Housekeeping report codes." }, { "name": "onlyOpportunities", "value": "", "type": "query", "description": "Indicates that only Opportunity blocks will be fetched." }, { "name": "multipleHotelsSearchHotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "blockStatusCode", "value": "", "type": "query", "description": "Supported Housekeeping report codes." } ] }, "docs": "This API retrieves block statistics.OperationId:getBlockStats
This API allows a time span of 90 days.
" }, { "info": { "name": "Retrieve/Ping Block stats service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/blockStats/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to retrieve block stats service status.OperationId:pingBlockStatsService
" } ] }, { "info": { "name": "BlockExternal", "type": "folder" }, "items": [ { "info": { "name": "Ping the Block service ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/blockExternal/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to facilitate ping the Block service.OperationId:pingBlockExternalServiceStatus
" } ] } ], "bundled": true }