|
|
|
IDeaS V5i Room Type Changes API
IDeaS, a third-party external interface used for Yield or Revenue Management, is connected to OPERA PMS through direct calls to OPERA's IDeaS API. The V5i Room Type Changes API allows the V5i client to collect certain reservation transaction level data. This API fetches data for both historical dates and future dates.
To enable this functionality, IDeaS makes the V5i Room Type Changes API call providing basic information. In response, OPERA creates a session specific temporary table containing the requested data. IDeaS then fetches records from this table; all conversion and interpretation of revenue amounts takes place on the IDeaS side.
This API will populate a temporary table (session specific) which must then be queried to fetch the required data.
--populate forecast information
DECLARE
s varchar2(100);
BEGIN
v5i_occupancy.get_future_resv(pms_p.resort,pms_p.business_date,12,s);
IF s!='SUCCESS' THEN
dbms_output.put_line('ERROR: '||s);
END IF;
END;
PROCEDURE get_future_resv(in_resort IN varchar2,
in_from_date IN date,
in_number_of_days IN number,
out_message OUT varchar2);
Where:
--populate statistical information
DECLARE
s varchar2(100);
BEGIN
v5i_occupancy.get_past_resv(pms_p.resort,pms_p.business_date-1,1,s);
IF s!='SUCCESS' THEN
dbms_output.put_line('ERROR: '||s);
END IF;
END;
PROCEDURE get_past_resv(in_resort IN varchar2,
in_from_date IN date,
in_past_days IN number,
out_message OUT varchar2);
Where:
Field |
Data Type |
Notes |
RESV_STATUS |
VARCHAR(20) |
Reservation status |
SHARED_YN |
VARCHAR(1) |
Share indicator |
SHARERS_LIST |
VARCHAR(2000) |
Confirmation number list of sharers |
TRX_DATE |
DATE |
Transaction date of the reservation |
ARRIVAL |
DATE |
Reservation arrival date |
DEPARTURE |
DATE |
Reservation departure date |
CHECKED_OUT_DATE |
DATE |
Reservation checked out date |
CANCELLATION_DATE |
DATE |
Reservation cancellation date |
BOOKING_DATE |
DATE |
Reservation booking date |
RATE_CODE |
VARCHAR(20) |
Rate code of the reservation |
RATE_AMOUNT |
NUMBER |
Rate amount of the reservation |
MARKET_CODE |
VARCHAR(20) |
Market code of the reservation |
ROOM |
VARCHAR(20) |
Room number |
ROOM_REVENUE |
NUMBER |
Room revenue |
FB_REVENUE |
NUMBER |
Food and beverage revenue |
OTHER_REVENUE |
NUMBER |
Other revenue |
TOTAL_REVENUE |
NUMBER |
Total revenue for the reservation |
ROOM_TYPE |
VARCHAR(20) |
Room type associated with the reservation at the current time |
SOURCE_CODE |
VARCHAR(20) |
Reservation source code |
CHANNEL |
VARCHAR(40) |
Reservation channel code |
BOOKED_ROOM_TYPE |
VARCHAR(20) |
Room type associated with the reservation at time of booking |
NATIONALITY |
VARCHAR(20) |
Nationality code |
RESV_TYPE |
VARCHAR(20) |
Reservation type (booking type) |
CHILDREN |
NUMBER |
Number of children |
ADULTS |
NUMBER |
Number of adults |
It is expected that separate calls to the API will be made by the IDeaS integration mechanism depending on whether statistical or forecast data is required, as past date data will be requested periodically while future on-the-books data will be requested daily. A single extraction is not expected to include both past and future dates.
As with the Occupancy APIs – there will be a past element and a future element to our extraction, so in this regard we are anticipating that the transaction API will be used in the same way. The daily request of data will include a very small number of past dates to ensure that we always have the latest updates for recently departed reservations.
Food and Beverage revenue will be combined into a single amount as OPERA does not break this out separately.
In regards to Day Use reservations, these are included within the API and as revenue is going to be included we would anticipate that this information is required. Note, for DU reservations the Departure date is going to equal the Arrival date.
