JSON API - GETRESRULE

Owned by Vincent Josset

Last updated: Mar 03, 2023

1 min read

Returns the applicable booking rules for the specified RuleArea and Reservation.

Input

brandid string The BrandID for which to pull the requested rule
rulearea string The RuleArea of the rule to return
resnumber integer The ResNumber of the reservation whose applicable rule to return

Output

Returns an array of applicable Rule objects for the specified Reservation and RuleArea.

Each Rule object will have four fields:

rulearea string The RuleArea of this Rule object
ruleid integer The unique ID for this Rule object
ruletext string The Rule’s content
description string Description of this Rule and its use and purpose

Example

[
  {
    "rulearea": "DEPOSITAMOUNT",
    "ruleid": 12345,
    "ruletext": "100.00",
    "description": "Deposit amount rule"
  }
]