Filter Parameters

Below are the available filters for activities. These get passed as JSON during your HTTP post.

Name Example Type Options
fromDate 2023-12-12 DATE
toDate 2023-12-17 DATE
search Apartment VARCHAR
resortId 1 INTEGER
rooms See example ARRAY
bypassRoomMaxOccupancy 1 INTEGER
  • 1: Bypass is active
  • 0: Bypass is inactive

The purpose of the bypassRoomMaxOccupancy is to allow more accommodation results to display regardless of the passenger combination. We suggest that you include logic to only enable the bypass if the customer is searching for a larger group of people i.e. 6 adults+

Important Note: If you are using the bypass max occupancy, please note that the price will not be provided for 'per person' priced accommodation. Prices will only be returned for 'per unit' prices accommodation (i.e. apartments) as the configuration of passengers does not affect the the price per room. We recommend in that you add logic on your website to allow for this.

Additional logic suggestions for when the bypass is active
  • If accommodationRates matches PP hide from pricing else if accommodationRates matches PU show from pricing
  • if bypassRoomMaxOccupancy is active replace the string defining the number of passengers (i.e. "This price is based on X adults) with another message for example "If you are travelling with a large group of people you may wish to search for a smaller number of passengers and book multiple rooms. The price displayed is based on a maximum occupancy shown in the description above"
Name Example Type Options
adults 1 INTEGER
children 1 INTEGER
childrenAges 10 ARRAY