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

Jump to bottom

Restriction splicing - remove restricted #568

Merged
merged 4 commits into from
Jun 18, 2024
Merged

Restriction splicing - remove restricted #568

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2588406
Restriction splicing - remove restricted
Filip-Macecek Mar 8, 2024
95125c1
Remove restricted labels
Filip-Macecek Jun 17, 2024
81eb69e
Update README.md
MikeAdamsMews Jun 18, 2024
2ba0ec4
Merge branch 'master' into restrictions-remove-ff
MikeAdamsMews Jun 18, 2024
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
3 changes: 3 additions & 0 deletions changelog/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Changelog

## 18th June 2024
* Removed **Restricted!** status from [Set restrictions](../operations/restrictions.md#set-restrictions) and [Clear restrictions](../operations/restrictions.md#clear-restrictions).

## 5th March 2024
* Extended [Payment request](../operations/paymentrequests.md#payment-request) response object with `ReservationId`, this affects the following operations:
* [Get all payment requests](../operations/paymentrequests.md#get-all-payment-requests)
Expand Down
4 changes: 2 additions & 2 deletions operations/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ This section describes all operations supported by the API, organised here by th
| [Get all restrictions](restrictions.md#get-all-restrictions) | Returns all restrictions of the default service provided by the enterprise |
| [Add restrictions](restrictions.md#add-restrictions) | Adds new restrictions with the specified conditions |
| [Delete restrictions](restrictions.md#delete-restrictions) | Removes restrictions from the service |
| [Set restrictions](restrictions.md#set-restrictions) | **Restricted!** Adds new restrictions with the specified conditions |
| [Clear restrictions](restrictions.md#clear-restrictions) | **Restricted!** Clears restrictions which meet specified conditions over a specified time interval |
| [Set restrictions](restrictions.md#set-restrictions) | Adds new restrictions with the specified conditions |
| [Clear restrictions](restrictions.md#clear-restrictions) | Clears restrictions which meet specified conditions over a specified time interval |
| [Add order](orders.md#add-order) | Creates a new order with the specified products and items |
| [Get all companionships](companionships.md#get-all-companionships) | Returns all companionships based on customers, reservations or reservation groups |
| [Get all resource access tokens](resourceaccesstokens.md#get-all-resource-access-tokens) | Returns all resource access tokens based on resource access tokens, reservations or interval |
Expand Down
6 changes: 0 additions & 6 deletions operations/restrictions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,9 +387,6 @@ Removes restrictions from the service.

## Set restrictions

> ### Restricted!
> This operation is currently in beta-test and as such it is subject to change. Use of this operation must be enabled per enterprise. Please contact the Technical Partner Support team in order to enable it.
Adds new restrictions with the specified conditions. For improved efficiency, multiple similar restrictions will be merged into a single restriction - see [Merging algorithm](#merging-algorithm). A quota of 150000 restrictions per service applies, although it is unlikely to be exceeded because of the [Merging algorithm](#merging-algorithm).
Note care is needed to specify `StartUtc` and `EndUtc` in the correct format - see [Datetimes](../guidelines/serialization.md#datetimes). The validation of these properties is stronger in this operation than for [Add restrictions](#add-restrictions).

Expand Down Expand Up @@ -487,9 +484,6 @@ Only restrictions created through the API are affected by this operation, _not_

## Clear restrictions

> ### Restricted!
> This operation is currently in beta-test and as such it is subject to change. Use of this operation must be enabled per enterprise. Please contact the Technical Partner Support team in order to enable it.
Deletes restrictions that [match the conditions](#matching-conditions) using the [splicing algorithm](#splicing-algorithm). This operation is intended to be used alongside [Set restrictions](#set-restrictions).

The specified conditions must be met exactly - see [Matching conditions](#matching-conditions) below. The time interval, however, does not need to correspond with an existing restriction in the system, instead the API uses a splicing algorithm to work out how to divide up any existing restrictions to meet the specified time interval - see [Time interval splicing](#time-interval-splicing).
Expand Down