Propertys

Date-independent equipment fit for site room types

Date-independent equipment fit for a property's site room types.

Answers "can this rig physically fit?" without picking dates, so the property page can disable non-fitting site room types as soon as a guest enters equipment, and agents can compare fit before checking availability. Only guest-visible site room types are returned; accommodation room types have no equipment-fit concept and are omitted (treat them as always fitting).

Fit combines three orthogonal signals (see RoomTypeEquipmentFit): dimensions_pending, equipment_type_excluded, and sites_matching. The dimension rules (length strict, width relaxed) are shared with GET /properties/{id}/availability so the date-gated calendar and this endpoint never diverge.

get/properties/{property_id}/equipment-fit

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties/{property_id}/equipment-fit
  • Auth: none declared

Path parameters

property_idinteger required

Query parameters

equipment_lengthnumber nullable

Equipment length in metres (enables dimension fit).

equipment_widthnumber nullable

Equipment width in metres (optional, relaxed filter).

equipment_typestring nullable

Canonical equipment type (e.g. 'caravan', 'motorhome') for RMS dwelling-type compatibility checking.

room_type_idinteger nullable

Restrict the result to a single site room type.

country'AU' | 'NZ'

ISO country code used to scope public property inventory.

Headers

API-Version'1'

Major API version. Omit or send 1 for the current v1 surface. Retired operations use RFC 9745 Deprecation and RFC 8594 Sunset headers.

Response

Successful Response

property_idinteger required

Property the verdicts belong to.

equipment_lengthnumber nullable

Echoed equipment length (metres) used for dimension fit.

equipment_widthnumber nullable

Echoed equipment width (metres) used for dimension fit.

equipment_typestring nullable

Echoed canonical equipment type used for RMS type compatibility.

Changes

No recorded changes to this operation across all 1 revision of this API.