Overview
Parcel Mode (parcelMode) is a new parameter available in the AI Feature API, which allows users to specify how roof and building features are managed when the feature extends across adjacent parcels. This parameter is typically used with other Nearmap API products such as the Roof Spotlight Index.
Note: The parcelMode parameter will take effect on Gen6 resources only
parcelMode quick info
Available for properties in | USA, AU |
|---|
Available in APIs | AI Features API |
Available in Applications | N/A |
parcelMode options
parcelMode is a boolean parameter that is set to false, as a default. In this mode, features that extend across multiple parcels are returned as is. To clip (trim) such features to a single parcel, set parcelMode=true.
When you do this, the features are "clipped" to the parcel boundary and bits that extend to adjacent parcels are omitted for the purpose of calculations such as RSI.
Note: Before clipping a feature to a parcel boundary, we first verify whether the feature is associated with both the parcel of interest and the adjoining parcel. We only proceed with clipping if the feature is shared by both parcels. This helps prevent clipping caused by slight mis-alignments in parcel boundaries, ensuring that only features truly shared between parcels are modified
Output
When the Request contains parcelMode=true and a feature is clipped to the parcel boundary, an additional clippedGeometry parameter is provided. Otherwise, only the default geometry class is provided.
When the Request contains parcelMode=true each feature is returned with a field belongsToParcel. If the feature belongs to the parcel, the belongsToParcel field will be set to ‘true’.
