v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Smart Policy Exceptions

List all policy exceptions for a property.

get/smart-policies/v1/exceptions

Query parameters

This parameter should be formatted as a list of strings separated by ;

{
  "filters": {
    "and": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ],
    "or": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ]
  }
}

limitinteger

The maximum number of items to return in the response. Default is 100.

offsetinteger

The number of items to skip before starting to collect the result set. Used for pagination.

A string specifying fields for sorting with optional directions (e.g., asc or desc).

{
  "sort": {
    "fields": [
      {
        "field": "checkin_date"
      }
    ]
  }
}

Headers

x-property-idstring required

Example:1,2,3

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

Response

List of policy exceptions.

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": [
    {
      "id": "5001",
      "propertyId": "1234",
      "name": "Winter holiday exception",
      "policyRootId": "1001",
      "enabled": true,
      "createdBy": "9876",
      "createdAt": "2024-01-01T10:00:00+00:00",
      "updatedAt": "2024-01-15T12:00:00+00:00",
      "intervals": [
        {
          "startDate": "2024-01-01",
          "endDate": "2024-01-31",
          "day0": true,
          "day1": true,
          "day2": true,
          "day3": true,
          "day4": true,
          "day5": true,
          "day6": true
        }
      ],
      "rates": [
        {
          "packageId": "123",
          "roomTypeId": "456"
        }
      ]
    }
  ]
}