From eefc1ee75fed79d05b4cb03397d186dd20d90c90 Mon Sep 17 00:00:00 2001 From: Britta Becker <75796443+BrittaBecker@users.noreply.github.com> Date: Mon, 3 Jul 2023 15:23:39 +0200 Subject: [PATCH 1/6] "Type" missing in rates/getAll documentation.md For rates/getAll, the response includes the type of rate (e.g. private, public, availability block). This is not mentioned in the documentation but in swagger. This value is very helpful to determine which rates are availability block rates and which ones are not. --- operations/rates.md | 1 + 1 file changed, 1 insertion(+) diff --git a/operations/rates.md b/operations/rates.md index 538e71e4..8486a722 100644 --- a/operations/rates.md +++ b/operations/rates.md @@ -116,6 +116,7 @@ Note this operation uses [Pagination](../guidelines/pagination.md) and supports | `IsActive` | boolean | required | Whether the rate is still active. | | `IsEnabled` | boolean | required | Whether the rate is currently available to customers. | | `IsPublic` | boolean | required | Whether the rate is publicly available. | +| `Type` | string | required | Type of the rate (Public, Private, AvailabilityBlock, etc.) | | `Name` | string | required | Name of the rate. | | `ShortName` | string | required | Short name of the rate. | | `ExternalNames` | [Localized text](_objects.md#localized-text) | required | All translations of the external name of the rate. | From fd4df01a438b29e034c7249cf5e9747f3b414b50 Mon Sep 17 00:00:00 2001 From: Mike Adams <92085514+MikeAdamsMews@users.noreply.github.com> Date: Thu, 20 Jul 2023 14:29:22 +0100 Subject: [PATCH 2/6] Added Changelog entry --- changelog/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/changelog/README.md b/changelog/README.md index ea95a326..dbbe796a 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -1,5 +1,9 @@ # Changelog +## 21st July 2023 + +* Added missing properties `Type` and `Description` to the documentation for [Get all rates](../operations/rates.md#get-all-rates) + ## 29th June 2023 * Documentation-only changes to add clarity around endpoint versioning. The deprecated version of `Get all reservations` is now called [Get all reservations \(ver 2017-04-12\)](../operations/reservations.md#get-all-reservations-ver-2017-04-12) and the new version is called [Get all reservations \(ver 2023-06-06\)](../operations/reservations.md#get-all-reservations-ver-2023-06-06). All relevant links have been updated. From 7a02ac0b23ed3039700a1ecf11cd2e64677a9c93 Mon Sep 17 00:00:00 2001 From: Mike Adams <92085514+MikeAdamsMews@users.noreply.github.com> Date: Thu, 20 Jul 2023 14:34:09 +0100 Subject: [PATCH 3/6] Update rates.md Added Rate type --- operations/rates.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/operations/rates.md b/operations/rates.md index 8486a722..de08ca03 100644 --- a/operations/rates.md +++ b/operations/rates.md @@ -139,6 +139,12 @@ Note this operation uses [Pagination](../guidelines/pagination.md) and supports | `RateId` | string | required | Unique identifier of the [Rate](#rate). | | `AvailabilityBlockId` | string | required | Unique identifier of the [Availability Block](availabilityblocks.md#availability-block). | +#### Rate type + +* `Public` +* `Private` +* `AvailabilityBlock` + ## Get rate pricing Returns prices for a given rate for a specified time interval. Prices will be returned for all service [time units](services.md#time-unit) that the specified time interval intersects. So, for example, an interval `1st Jan 23:00 UTC - 1st Jan 23:00 UTC` will result in one price for `2nd Jan`, while Interval `1st Jan 23:00 UTC - 2nd Jan 23:00 UTC` will result in two prices for `2nd Jan` and `3rd Jan` (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a [time unit](services.md#time-unit), e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The __maximum size of time interval__ is 100 time units or 2 years, whichever is the shorter amount of time. From 7bd9738521d7d401b46253d96e599177f48cbf17 Mon Sep 17 00:00:00 2001 From: Mike Adams <92085514+MikeAdamsMews@users.noreply.github.com> Date: Thu, 20 Jul 2023 14:36:23 +0100 Subject: [PATCH 4/6] Update README.md --- changelog/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/README.md b/changelog/README.md index dbbe796a..5b915e24 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -2,7 +2,7 @@ ## 21st July 2023 -* Added missing properties `Type` and `Description` to the documentation for [Get all rates](../operations/rates.md#get-all-rates) +* Added missing properties `Type` and `Description` to the response for [Get all rates](../operations/rates.md#get-all-rates) (change to documentation only) ## 29th June 2023 From 33ac06f5e8918f6a741c3f01ffae970e1c75bffd Mon Sep 17 00:00:00 2001 From: Mike Adams <92085514+MikeAdamsMews@users.noreply.github.com> Date: Thu, 20 Jul 2023 14:39:11 +0100 Subject: [PATCH 5/6] Update rates.md --- operations/rates.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/operations/rates.md b/operations/rates.md index de08ca03..015191d9 100644 --- a/operations/rates.md +++ b/operations/rates.md @@ -116,10 +116,11 @@ Note this operation uses [Pagination](../guidelines/pagination.md) and supports | `IsActive` | boolean | required | Whether the rate is still active. | | `IsEnabled` | boolean | required | Whether the rate is currently available to customers. | | `IsPublic` | boolean | required | Whether the rate is publicly available. | -| `Type` | string | required | Type of the rate (Public, Private, AvailabilityBlock, etc.) | +| `Type` | string [Rate type](#rate-type) | required | Type of the rate (Public, Private, etc.) | | `Name` | string | required | Name of the rate. | | `ShortName` | string | required | Short name of the rate. | | `ExternalNames` | [Localized text](_objects.md#localized-text) | required | All translations of the external name of the rate. | +| `Description` | [Localized text](_objects.md#localized-text) | required | All translations of the description of the rate. | | `ExternalIdentifier` | string | optional, max 255 characters | Identifier of the rate from external system. | #### Rate group From 8cf35e95b6ea28c66e0b59dd690ecb2158f3a7ab Mon Sep 17 00:00:00 2001 From: Britta Becker <75796443+BrittaBecker@users.noreply.github.com> Date: Fri, 4 Aug 2023 15:09:08 +0200 Subject: [PATCH 6/6] Update rates.md I've added the "type" parameters in the code example. Additionally, I noticed that the "options" parameter was also not described, so I added this as well. @MikeAdamsMews could you please check and adjust the "options" description if needed? Thanks! --- operations/rates.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/operations/rates.md b/operations/rates.md index 015191d9..46ddf062 100644 --- a/operations/rates.md +++ b/operations/rates.md @@ -63,23 +63,26 @@ Note this operation uses [Pagination](../guidelines/pagination.md) and supports { "Rates": [ { - "BaseRateId": null, - "BusinessSegmentId": null, - "GroupId": "c8b866b3-be2e-4a47-9486-034318e9f393", "Id": "ed4b660b-19d0-434b-9360-a4de2ea42eda", + "GroupId": "c8b866b3-be2e-4a47-9486-034318e9f393", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", - "IsActive": true, + "BaseRateId": null, + "BusinessSegmentId": null, + "IsActive": false, "IsEnabled": true, "IsPublic": true, - "Name": "Fully Flexible", - "ShortName": "FF", - "ExternalNames": { - "en-US": "Long Stay Flexible Rate" - }, - "ExternalIdentifier": "D001" + "Type": "Public", + "Name": "Fully Flexible Rate", + "ShortName": "FLEXFLEX", + "ExternalNames": {}, + "Description": {}, + "ExternalIdentifier": null, + "Options": { + "HidePriceFromGuest": false, + "IsBonusPointsEligible": false + } } - ], - "RateGroups": [ + ], "RateGroups": [ { "Id": "c8b866b3-be2e-4a47-9486-034318e9f393", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", @@ -122,6 +125,7 @@ Note this operation uses [Pagination](../guidelines/pagination.md) and supports | `ExternalNames` | [Localized text](_objects.md#localized-text) | required | All translations of the external name of the rate. | | `Description` | [Localized text](_objects.md#localized-text) | required | All translations of the description of the rate. | | `ExternalIdentifier` | string | optional, max 255 characters | Identifier of the rate from external system. | +| `Options` |[Localized text](_objects.md#localized-text)| required | Rate options. | #### Rate group