Overview

The Retrieve Rate Set request enables the Agent to access comprehensive rate details associated with properties within the CiiRUS system. This endpoint offers the ability to retrieve rate information for specific rate sets or all available rate sets.

The primary purpose of the Retrieve Rate Set request is to furnish API users with detailed rate information for available Inventory within the CiiRUS system.

Endpoints Available

Path Parameters

Query String Parameters

Response Definition

"rate_bands" Object

🚧

If a Rate is set as 000, this was defined by the Property Manager. Please contact the PM and request they populate this data. As long as a rateband has been defined (even as 000) for the date period of a reservation and the user has set the property to be bookable online, the property can be booked and the quote will be calculated based on the defined rates.

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/rates/ratesets?page=1&pageSize=50'

Sample Response

{
    "ratesets": [
        {
            "id": 72024,
            "set_name": "3-bedroom standard",
            "weekly_daily_monthly": 1,
            "use_default_floor_rate": false,
            "includes_tax": false,
            "days_in_month": 30,
            "based_on_arrival_date_band_only": false,
            "currency": "USD",
            "minimum_nightly_rate": 0.00,
            "rate_bands": [
                {
                    "id": 348421989,
                    "unit_id": 0,
                    "date_from": "2018-01-01T00:00:00",
                    "date_to": "2029-12-31T00:00:00",
                    "us_rate": 0.0000,
                    "rate_set_id": 72024,
                    "missing_band": 0,
                    "minimum_nights_stay": 3,
                    "arrival_days": 127,
                    "floor_rate": 120.0000,
                    "daily_rate": 100.0000,
                    "monthly_rate": 0.0000,
                    "departure_days": 127,
                    "season_name": "",
                    "maximum_nights_stay": 0
                },
              ...
              ],
          		"mc_user_id": 42330
           }
      ],
      "next_page_url": "https://api.ciiruspartners.com/v20230731/rates/ratesets?page=2&pageSize=25",
      "total_page_count": 6
}

📘

Arrival/Departure Day Restrictions - Bitwise Representation

Arrival and departure day restrictions refer to specific rules or limitations set by property owners or managers regarding the days on which guests are allowed to arrive or depart from the property. To efficiently represent and enforce these restrictions, a bitwise representation is utilized, where each day of the week is assigned a corresponding bit value.

Bitwise representation allows for the encoding of multiple restrictions into a single integer value.

In this specific representation, Monday serves as the starting point, and each day of the week is assigned a unique bit position as follows:

Monday: 1 (bit position 0)
Tuesday: 2 (bit position 1)
Wednesday: 4 (bit position 2)
Thursday: 8 (bit position 3)
Friday: 16 (bit position 4)
Saturday: 32 (bit position 5)
Sunday: 64 (bit position 6)

To determine the arrival/departure day restrictions for a property, the relevant bit positions are set to 1 to indicate the allowed days and 0 to indicate the restricted days.

Examples:

1. If a property allows arrival and departure on Monday, Wednesday, and Sunday, the bitwise representation would be 1 + 4 + 64 = 69
2. If a property allows arrival and departures on Tuesday, Wednesday, and Sunday, the bitwise representation would be 2 + 4 + 64 = 70
3. For a property that restricts arrivals and departures on Monday, Friday, and Saturday, the bitwise representation would be 0 + 16 + 32 = 48
4. If a property allows check-ins and check-outs on all days, the bitwise representation would be
   1 + 2 + 4 + 8 + 16 + 32 + 64 = 127