Rules

Get all rules
Returns all rules applied with the reservations.
Request
[PlatformAddress]/api/connector/v1/rules/getAll
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ServiceIds": [
        "bd26d8db-86da-4f96-9efc-e5a4654a4a94"
    ],
    "Extent": 
    {
        "RuleActions": true,
        "Rates": true,
        "RateGroups": true,
        "ResourceCategories": true,
        "BusinessSegments": true
    }
}
Property
Type
Contract
Description
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
Unique identifiers of the Services.
Extent
​Rule extent​
required
Extent of data to be returned.
Rule extent
Property
Type
Contract
Description
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": [
        {
            "Id": "13638b12-53f1-4b35-baab-ac1e006ed8cb",
            "Conditions": {
                "RateId": {
                    "Value": "8a13f4e8-0274-4bcc-b2d4-ac1c00d1cd3f",
                    "ConditionType": "Equals"
                },
                "RateGroupId": null,
                "BusinessSegmentId": null,
                "ResourceCategoryId": null,
                "ResourceCategoryType": null,
                "Origin": {
                    "Value": "Connector",
                    "ConditionType": "NotEquals"
                },
                "MinimumTimeUnitCount": null,
                "MaximumTimeUnitCount": null
            }
        }
    ],
    "RuleActions": [
        {
            "Id": "307e75a6-2cc8-4226-a600-ac1e006fbdb9",
            "RuleId": "13638b12-53f1-4b35-baab-ac1e006ed8cb",
            "Data": {
                "Discriminator": "Product",
                "Value": {
                    "ProductId": "122fd92d-c561-4995-8ebc-ac1c00d1eaa8",
                    "ActionType": "Add"
                }
            }
        }
    ],
    "Rates": [
        {
            "Id": "8a13f4e8-0274-4bcc-b2d4-ac1c00d1cd3f",
            "GroupId": "e4a9d8d1-5793-4d35-954e-ac1c00d1eaa8",
            "ServiceId": "ea80bbca-372f-4550-8e48-ac1c00d1cd20",
            "BaseRateId": null,
            "IsActive": true,
            "IsEnabled": true,
            "IsPublic": true,
            "Name": "Fully Flexible",
            "ShortName": "FF",
            "ExternalNames": {}
        }
    ],
    "RateGroups": [],
    "ResourceCategories": [],
    "BusinessSegments": []
}
Property
Type
Contract
Description
Rules
array of Rule​
required
Rules used with reservation creations and modifications.
RuleActions
array of Rule action​
required
Rule actions applied in rules.
Rates
array of Rate​
required
Rates used in conditions.
RateGroups
array of Rate group​
required
Rate groups used in conditions.
ResourceCategories
array of Resource category​
required
Resource categories used in conditions.
BusinessSegments
array of Business segment​
required
Business segments used in conditions.
Rule
Property
Type
Contract
Description
Id
string
required
Unique identifier of the rule.
Conditions
​Rule conditions​
required
Conditions of the rule.
Rule conditions
Property
Type
Contract
Description
RateId
​Rule condition​
required
Condition based on Rate.
RateGroupId
​Rule condition​
required
Condition based on Rate group.
BusinessSegmentId
​Rule condition​
required
Condition based on Business segment.
ResourceCategoryId
​Rule condition​
required
Condition based on Resource category.
ResourceCategoryType
​Rule condition​
required
Condition based on Resource category type.
Origin
​Rule condition​
required
Condition based on Reservation origin.
MinimumTimeUnitCount
string
required
Condition based on minimum amount of time units.
MaximumTimeUnitCount
string
required
Condition based on maximum amount of time units.
Rule condition
Property
Type
Contract
Description
ConditionType
string Condition type​
required
Type of condition.
Value
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
Id
string
required
Unique identifier of the rule action.
RuleId
string
required
Unique identifier of the rule.
Data
​RuleActionData​
optional
Additional information about action.
Rule action data
Property
Type
Contract
Description
Discriminator
string Rule action discriminator​
required
Determines type of value.
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
ProductId
string
required
Unique identifier of product.
ActionType
string Product action type​
required
Action of rule.
Product action type
Add - Adds specified item.
Delete - Deletes specified item.

Property	Type	Contract	Description
`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	Unique identifiers of the Services.
`Extent`	Rule extent	required	Extent of data to be returned.

Property	Type	Contract	Description
`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.

Property	Type	Contract	Description
`Rules`	array of Rule	required	Rules used with reservation creations and modifications.
`RuleActions`	array of Rule action	required	Rule actions applied in rules.
`Rates`	array of Rate	required	Rates used in conditions.
`RateGroups`	array of Rate group	required	Rate groups used in conditions.
`ResourceCategories`	array of Resource category	required	Resource categories used in conditions.
`BusinessSegments`	array of Business segment	required	Business segments used in conditions.

Property	Type	Contract	Description
`Id`	string	required	Unique identifier of the rule.
`Conditions`	Rule conditions	required	Conditions of the rule.

Property	Type	Contract	Description
`RateId`	Rule condition	required	Condition based on Rate.
`RateGroupId`	Rule condition	required	Condition based on Rate group.
`BusinessSegmentId`	Rule condition	required	Condition based on Business segment.
`ResourceCategoryId`	Rule condition	required	Condition based on Resource category.
`ResourceCategoryType`	Rule condition	required	Condition based on Resource category type.
`Origin`	Rule condition	required	Condition based on Reservation origin.
`MinimumTimeUnitCount`	string	required	Condition based on minimum amount of time units.
`MaximumTimeUnitCount`	string	required	Condition based on maximum amount of time units.

Property	Type	Contract	Description
`ConditionType`	string Condition type	required	Type of condition.
`Value`	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.

Property	Type	Contract	Description
`Id`	string	required	Unique identifier of the rule action.
`RuleId`	string	required	Unique identifier of the rule.
`Data`	RuleActionData	optional	Additional information about action.

Property	Type	Contract	Description
`Discriminator`	string Rule action discriminator	required	Determines type of value.
`Value`	object	required	Structure of object depends on Rule action discriminator.

Property	Type	Contract	Description
`ProductId`	string	required	Unique identifier of product.
`ActionType`	string Product action type	required	Action of rule.

Routing rules

Services

Last modified 8mo ago