From 36eb6509044f16fc7f35f1e276fdfede042de6be Mon Sep 17 00:00:00 2001 From: Stuart Ng Date: Mon, 8 Mar 2021 16:46:09 -0800 Subject: [PATCH 1/4] featL HOTEL-3054 Update HS2 API doc for rate categories --- .../hotel-service-2/Availability.markdown | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown index 1ab4c12ad..72e72ef88 100644 --- a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown +++ b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown @@ -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) @@ -79,6 +80,10 @@ Message to retrieved the availability of hotels. + + + + @@ -132,6 +137,13 @@ 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.| + +#### RatePlanCandidates +|Name|Type|Description| +|---------|------------------|-------------| +|`RatePlanCandidate/RatePlanType`|`complex`|**Required** Element used to identify rate categories requested. There can be multiple `RatePlanCandidate` per hotel| + #### StayDateRange @@ -187,7 +199,7 @@ The maximum allowed size of `OTA_HotelAvailRS` is 5 MB. Any response that exceed - + @@ -300,6 +312,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)| #### RatePlanDescription From ad241cd85770a568d19d07fd5de700240cfdcf51 Mon Sep 17 00:00:00 2001 From: Stuart Ng Date: Fri, 12 Mar 2021 10:17:53 -0800 Subject: [PATCH 2/4] clarify comments --- .../hotel-service-2/Availability.markdown | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown index 72e72ef88..cfea037ee 100644 --- a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown +++ b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown @@ -85,6 +85,13 @@ Message to retrieved the availability of hotels. + + + + + + + @@ -142,8 +149,7 @@ Message to retrieved the availability of hotels. #### RatePlanCandidates |Name|Type|Description| |---------|------------------|-------------| -|`RatePlanCandidate/RatePlanType`|`complex`|**Required** Element used to identify rate categories requested. There can be multiple `RatePlanCandidate` per hotel| - +|`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`| #### StayDateRange From 19d05ab2ebc8755bc13fd73d521ac7acde82bdc6 Mon Sep 17 00:00:00 2001 From: Stuart Ng Date: Fri, 12 Mar 2021 11:29:01 -0800 Subject: [PATCH 3/4] pr comment - remove optional qualifier --- .../direct-connects/hotel-service-2/Availability.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown index cfea037ee..7537654d7 100644 --- a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown +++ b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown @@ -144,7 +144,7 @@ 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.| +|`RatePlanCandidates`|`complex`|Allow sending of requested rate categories. Only one `RatePlanCandidates` inside for each hotel.| #### RatePlanCandidates |Name|Type|Description| @@ -318,7 +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)| +|`RatePlanType`|`integer`|Specify the rate plan type of this rate. Refer to Open Travel Code List Rate Plan Type (RPT)| #### RatePlanDescription From 65c8ab20f8938678a3a637035143bbd1a8adb0a1 Mon Sep 17 00:00:00 2001 From: Stuart Ng Date: Fri, 19 Mar 2021 11:23:44 -0700 Subject: [PATCH 4/4] scope reduced to only response for now --- .../hotel-service-2/Availability.markdown | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown index 7537654d7..419316009 100644 --- a/src/api-reference/direct-connects/hotel-service-2/Availability.markdown +++ b/src/api-reference/direct-connects/hotel-service-2/Availability.markdown @@ -18,7 +18,6 @@ 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) @@ -80,17 +79,6 @@ Message to retrieved the availability of hotels. - - - - - - - - - - - @@ -144,12 +132,6 @@ 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`|Allow sending of requested rate categories. Only one `RatePlanCandidates` inside for each hotel.| - -#### 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`| #### StayDateRange