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
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceIds
array of string
required, max 1000 items
UpdatedUtc
optional, max length 3 months
Extent
required
Extent of data to be returned.
Limitation
required
Limitation on the quantity of data returned.
Rule extent
RuleActions
bool
optional
Whether the response should contain rule actions.
Rates
bool
optional
Whether the response should contain rates.
RateGroups
bool
optional
Whether the response should contain rate groups.
ResourceCategories
bool
optional
Whether the response should contain rate resource categories.
BusinessSegments
bool
optional
Whether the response should contain business segments.
Response
Rules
required
Rules used with reservation creations and modifications.
RuleActions
required
Rule actions applied in rules.
Rates
required
Rates used in conditions.
RateGroups
required
Rate groups used in conditions.
ResourceCategories
required
Resource categories used in conditions.
BusinessSegments
required
Business segments used in conditions.
Cursor
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
Id
string
required
Unique identifier of the rule.
ServiceId
string
required
Conditions
required
Conditions of the rule.
CreatedUtc
string
required
Creation date and time of the rule in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the rule in UTC timezone in ISO 8601 format.
Rule conditions
RateId
required
RateGroupId
required
BusinessSegmentId
required
ResourceCategoryId
required
ResourceCategoryType
required
Origin
required
TravelAgencyId
required
MinimumTimeUnitCount
string
required
Condition based on minimum amount of time units.
MaximumTimeUnitCount
string
required
Condition based on maximum amount of time units.
Rule condition
ConditionType
required
Type of condition.
Value
string
required
Condition type
Equals
NotEquals
Rule action
Id
string
required
Unique identifier of the rule action.
RuleId
string
required
Unique identifier of the rule.
Data
optional
Additional information about action.
Rule action data
Discriminator
required
Determines type of value.
Value
object
required
Rule action discriminator
Product
- Data specific to a product.
Rule action product data
ProductId
string
required
Unique identifier of product.
ActionType
required
Action of rule.
Product action type
Add
- Adds specified item.Delete
- Deletes specified item.
Last updated