Oracle Hospitality Block Config API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BlockConfig. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
32 operations
across 23 paths,
and defines 56 schemas.
It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /blk/config/v1.
The identity and technical contract details declared by the specification.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
cutoffCodeCriteria
object
Object which will contain all the information of 'CutoffCodes'.
3 properties
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
salesManagerGoalsInfo
object
You can use this API to retrieve individual Sales Manager Goals for a hotel, you can narrow the results using different search criteria
3 properties
nextBlockStatusCodeInfoListType
array
List of all configured next status codes for the main status code.
blockSalesAllowanceListType
array
Block's sales allowance information.
blockSalesAllowanceType
object
Contains single entry information for Block's Sales Allowance.
8 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
nextBlockStatusCode
object
Request object for change block status code flow. Batch insert/update/delete of next status code list of a particular status code.
3 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
washCodesType
array
Wash Code, which will allow the user to define standard schedules that can be attached to blocks prior to the block's cutoff date to automate this process.
cutoffCodeType
object
A representation of the information contained by a Cutoff Code.
8 properties
salesManagerGoalType
object
Detail Information about Sales Manager's goal.
25 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
washCodeDetailsType
array
Wash Code Detail for a single entry.
salesManagersType
object
Collection of Sales Managers information.
7 properties
nextBlockStatusCodeDetails
object
Response object for fetching next block status codes.
4 properties
nextBlockStatusCodeType
object
Next block status codes information. Contains list of all configured and/or available next status codes for a particular status code.
3 properties
blockStatusCodeListType
array
Block status code information.
blockSalesAllowanceRange
object
Operation to a create block sales allowance with date range.
3 properties
blockCutoffScheduleRangeType
object
Object to create block cutoff schedule details by providing date range, room type, days of week and cutoff days.
14 properties
cutoffScheduleDetails
object
Object which will contain all the information of 'CutoffCodes'.
9 properties
salesManagersInfo
object
You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria
3 properties
cutoffCodeDetail
object
A representation of the single entry information for cutoff schedule detail.
4 properties
washScheduleDetails
object
Response object for FetchWashSchedule operation which will contain all the information of 'WashCodes' like Days prior to arrival, Occupancy detail, Sell limit…
3 properties
salesManagerGoalsType
array
Detail Information about Sales Manager's goal.
washScheduleCriteria
object
Operation to create new Wash Schedule Configuration under the selected property.
3 properties
status
object
Response Body.
2 properties
nextBlockStatusCodeInfoType
object
Information of next block status code.
2 properties
searchSalesManagersRequest
object
5 properties
blockSalesAllowance
object
Response object for FetchBlockSalesAllowance operation which will contain all the information of sales allowance.
3 properties
washCodeType
object
A representation of the information contained by a Wash Code.
5 properties
searchSalesManagersMultipleHotelIdsRequest
object
6 properties
1 required
blockStatusCodeType
object
Block status code information.
17 properties
statusCodeDetails
object
Response object for fetching block status codes.
3 properties
createSalesManagerGoals
object
Request object for Creating Sales Manager Goal(s).
2 properties
washCodeDetailType
object
Allows for a choice to populate the detail information based on the choice between 'Wash by number of rooms' and 'Wash by %'.
3 properties
blockSalesAllowanceRangeType
object
Indicates the block sales allowance for a date range.
15 properties
blockCutoffScheduleRange
object
Operation to a create block cutoff schedule details by providing date range, room type, days of week and cutoff days.
3 properties
nextBlockStatusCodeListType
array
Block status code with its next configured and/or available status codes.
warningsType
array
Used in conjunction with the Success element to define a business error.
blockStatusCodeStatusType
string
Simple type for block status code's room status type and catering status type. Valid status values are Waitlist,Cancel,Lost,Refused,Actual,Inquiry,NonDeductInv…
washByRoomType
object
A representation of the single entry information for 'Wash by number of rooms' type.
5 properties
blockSalesAllowanceActivityLog
object
Response object for fetching block sales allowance activity log.
3 properties
blockStatusCodeDetails
object
Request object for updating block status code.
3 properties
operaVersion
object
Response for Ping operation.
3 properties
cutoffCodeDetailType
object
Cutoff Code Detail for a single entry
1 property
operaVersionNumberType
string
Current Opera Version Number
statusColorType
string
Status code color configuration type.
salesManagerType
object
Sales Manager's information.
7 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
blockSalesAllowanceActivityLogListType
object
7 properties
blockSalesAllowanceActivityLogType
object
10 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.
