v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Smart Policy Exceptions

Search eligible rate plans and base rates with conflict info.

post/smart-policies/v1/exceptions/eligible-rates/search

Headers

x-property-idstring required

Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Request body

limitinteger

The limit for the number of items to return (max 500)

offsetinteger

The offset for the current page of results

startDatestring date required

Start date of the date range to filter rate plans.

endDatestring date required

End date of the date range to filter rate plans.

exceptionIdstring nullable

Exception ID to exclude from conflict detection (when editing an existing exception).

Example request

{
  "limit": 1,
  "offset": 1,
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "intervals": [
    {
      "startDate": "2024-01-01",
      "endDate": "2024-01-31",
      "day0": true,
      "day1": true,
      "day2": true,
      "day3": true,
      "day4": true,
      "day5": true,
      "day6": true
    }
  ],
  "exceptionId": "123"
}

Response

Eligible rate plans and base rates with conflict info.

totalinteger required

The total number of items available.

limitinteger required

The limit for the number of items to return.

offsetinteger required

The offset for the current page of results.

Example response

{
  "data": [
    {
      "name": "Standard Rate",
      "type": "rate_plan",
      "packageId": "123",
      "roomTypeId": "789",
      "policyId": "456",
      "conflict": {
        "exceptionId": "123",
        "exceptionName": "Holiday Override"
      }
    }
  ]
}