Rules
Get all rules
Returns all rules applied with the reservations. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/rules/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifiers of the Services. |
| optional, max length 3 months | Interval in which Rule was updated. | |
| required | Extent of data to be returned. | |
| required | Limitation on the quantity of data returned. |
Rule extent
Property | Type | Contract | Description |
---|---|---|---|
| bool | optional | Whether the response should contain rule actions. |
| bool | optional | Whether the response should contain rates. |
| bool | optional | Whether the response should contain rate groups. |
| bool | optional | Whether the response should contain rate resource categories. |
| bool | optional | Whether the response should contain business segments. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Rule | required | Rules used with reservation creations and modifications. |
| array of Rule action | required | Rule actions applied in rules. |
| array of Rate | required | Rates used in conditions. |
| array of Rate group | required | Rate groups used in conditions. |
| array of Resource category | required | Resource categories used in conditions. |
| array of Business segment | required | Business segments used in conditions. |
| string | optional | Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. |
Rule
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the rule. |
| string | required | Unique identifier of the Service the rule is assigned to. |
| required | Conditions of the rule. | |
| string | required | Creation date and time of the rule in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the rule in UTC timezone in ISO 8601 format. |
Rule conditions
Property | Type | Contract | Description |
---|---|---|---|
| required | Condition based on Rate. | |
| required | Condition based on Rate group. | |
| required | Condition based on Business segment. | |
| required | Condition based on Resource category. | |
| required | Condition based on Resource category type. | |
| required | Condition based on Reservation origin. | |
| required | Condition based on Company. | |
| string | required | Condition based on minimum amount of time units. |
| string | required | Condition based on maximum amount of time units. |
Rule condition
Property | Type | Contract | Description |
---|---|---|---|
| string Condition type | required | Type of condition. |
| string | required | Value of the condition depending on the property. E.g. Reservation origin in case of origin condition or unique identifier of a rate in case of rate condition. |
Condition type
Equals
NotEquals
Rule action
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the rule action. |
| string | required | Unique identifier of the rule. |
| optional | Additional information about action. |
Rule action data
Property | Type | Contract | Description |
---|---|---|---|
| string Rule action discriminator | required | Determines type of value. |
| object | required | Structure of object depends on Rule action discriminator. |
Rule action discriminator
Product
- Data specific to a product.
Rule action product data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of product. |
| string Product action type | required | Action of rule. |
Product action type
Add
- Adds specified item.Delete
- Deletes specified item.
Last updated