Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Type" missing in rates/getAll documentation.md #470

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
+28 −12
Draft

"Type" missing in rates/getAll documentation.md #470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eefc1ee
"Type" missing in rates/getAll documentation.md
BrittaBecker Jul 3, 2023
fd4df01
Added Changelog entry
MikeAdamsMews Jul 20, 2023
7a02ac0
Update rates.md
MikeAdamsMews Jul 20, 2023
7bd9738
Update README.md
MikeAdamsMews Jul 20, 2023
33ac06f
Update rates.md
MikeAdamsMews Jul 20, 2023
8cf35e9
Update rates.md
BrittaBecker Aug 4, 2023
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
4 changes: 4 additions & 0 deletions changelog/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 21st July 2023

* 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

* 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.
Expand Down
36 changes: 24 additions & 12 deletions operations/rates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {},
Copy link
Contributor

Choose a reason for hiding this comment

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

We prefer to use real examples, rather than just blank. I guess it would be something like this:

   "Description": {
      "en-US": "Fully flexible rate",
      "de-DE": "Völlig flexibler Tarif"
   },

"ExternalIdentifier": null,
"Options": {
Copy link
Contributor

Choose a reason for hiding this comment

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

What is Options? This has sneaked in to the PR.

"HidePriceFromGuest": false,
"IsBonusPointsEligible": false
}
}
],
"RateGroups": [
], "RateGroups": [
{
"Id": "c8b866b3-be2e-4a47-9486-034318e9f393",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
Expand Down Expand Up @@ -116,10 +119,13 @@ 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 [Rate type](#rate-type) | required | Type of the rate (Public, Private, etc.) |
| `Name` | string | required | Name of the rate. |
MikeAdamsMews marked this conversation as resolved.
Show resolved Hide resolved
| `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. |
| `Options` |[Localized text](_objects.md#localized-text)| required | Rate options. |
Copy link
Contributor

Choose a reason for hiding this comment

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

As above, what is Options? I checked the YAML and it's not in there.


#### Rate group

Expand All @@ -138,6 +144,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.
Expand Down