Skip to content
This repository was archived by the owner on Apr 29, 2022. It is now read-only.

DO NOT MERGE - feat: HOTEL-3054 Rate Categories in HS2 #2645

Open
stuart-ng-van wants to merge 4 commits into
base: preview
Choose a base branch
from
Open

DO NOT MERGE - feat: HOTEL-3054 Rate Categories in HS2 #2645

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36eb650
featL HOTEL-3054 Update HS2 API doc for rate categories
stuart-ng-van Mar 9, 2021
ad241cd
clarify comments
stuart-ng-van Mar 12, 2021
19d05ab
pr comment - remove optional qualifier
stuart-ng-van Mar 12, 2021
65c8ab2
scope reduced to only response for now
stuart-ng-van Mar 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion src/api-reference/direct-connects/hotel-service-2/Availability.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Message to retrieved the availability of hotels.
* [Hotel Search Criteria](#hotel-search-criteria)
* [Criterion](#criterion)
* [Stay Date Range](#stay-date-range)
* [Rate Plan Candidates](#rate-plan-candidates)
* [Room Stay Candidates](#room-stay-candidates)
* [Room Stay Candidate](#room-stay-candidate)
* [Guest Counts](#guest-counts)
Expand Down Expand Up @@ -79,6 +80,17 @@ Message to retrieved the availability of hotels.
<HotelSearchCriteria>
<Criterion>
<HotelRef ChainCode="ZZ" HotelCode="111222"></HotelRef>
<RatePlanCandidates>
<RatePlanCandidate RatePlanType="8"></RatePlanCandidate>
<RatePlanCandidate RatePlanType="9"></RatePlanCandidate>
</RatePlanCandidates>
</Criterion>
<Criterion>
<HotelRef ChainCode="ZZ" HotelCode="56012"></HotelRef>
<RatePlanCandidates>
<RatePlanCandidate RatePlanType="8"></RatePlanCandidate>
<RatePlanCandidate RatePlanType="9"></RatePlanCandidate>
</RatePlanCandidates>
</Criterion>
</HotelSearchCriteria>
<StayDateRange Start="2018-10-26" End="2018-10-28"></StayDateRange>
Expand Down Expand Up @@ -132,6 +144,12 @@ Message to retrieved the availability of hotels.
|---------|------------------|-------------|
|`HotelRef/HotelCode`|`stringLength1to16`|**Required** The code that uniquely identifies a single hotel property. The hotel code is decided by vendors.|
|`HotelRef/ChainCode`|`stringLength1to8`|The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the `HotelCode` attribute.|
|`RatePlanCandidates`|`complex`|**Optional** Allow sending of requested rate categories. Only one `RatePlanCandidates` inside for each hotel.|

#### <a name="rate-plan-candidates"></a>RatePlanCandidates
|Name|Type|Description|
|---------|------------------|-------------|
|`RatePlanCandidate/RatePlanType`|`complex`|**Required** Identify rate categories requested. Refer to Open Travel Code List Rate Plan Type (RPT). There can be multiple `RatePlanCandidate` per `RatePlanCandidates`|

#### <a name="stay-date-range"></a>StayDateRange

Expand Down Expand Up @@ -187,7 +205,7 @@ The maximum allowed size of `OTA_HotelAvailRS` is 5 MB. Any response that exceed
</RoomType>
</RoomTypes>
<RatePlans>
<RatePlan RatePlanID="XNFYP4I" AvailabilityStatus="ChangeDuringStay">
<RatePlan RatePlanID="XNFYP4I" AvailabilityStatus="ChangeDuringStay" RatePlanType="4">
<Guarantee GuaranteeType="GuaranteeRequired" />
<CancelPenalties>
<CancelPenalty>
Expand Down Expand Up @@ -300,6 +318,7 @@ For a description of the relationship between the `RoomID` and `RatePlanID` refe
|`CancelPenalties`|`complex`|**Required if `RateDetailsInd` is `true` or not present** Collection of cancellation penalties. If the cancel penalties are not provided SAP Concur will display: "Cancellation policy not provided by vendor".|
|`MealsIncluded`|`complex`|Defines which meals are included with this rate program.|
|`RatePlanDescription`|`complex`|Textual information regarding the Rate Plan.|
|`RatePlanType`|`integer`|**Optional** specify the rate plan type of this rate. Refer to Open Travel Code List Rate Plan Type (RPT)|
Copy link
Copy Markdown
Contributor Author

@stuart-ng-van stuart-ng-van Mar 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CWT is overloading this to indicate refunable rates, will need to get them to change for T2

Copy link
Copy Markdown
Contributor

@rlee-sap rlee-sap Mar 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not common construct in our docs to identify **Optional**

Copy link
Copy Markdown
Contributor Author

@stuart-ng-van stuart-ng-van Mar 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rlee-sap - i do think it makes the doc more clear, but agree it's not common in other parts. will remove

Copy link
Copy Markdown
Contributor Author

@stuart-ng-van stuart-ng-van Mar 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, please review again

Copy link
Copy Markdown
Contributor Author

@stuart-ng-van stuart-ng-van Mar 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rlee-sap


#### <a name="rate-plan-description"></a>RatePlanDescription

Expand Down