PUpurplegrain
Properties

Search cadastral parcels for a property

Changed on

Queries the state's externally operated public cadastre for parcels at or near a point. The state is read from the property's address. Send latitude and longitude, or an address. When both are sent, the coordinates are used and the address is ignored. The address is not stored, logged or used as a cache key. The property's PIC is the farmer's own declaration. It is not looked up and it is not sent to the cadastre.

NSW, VIC, QLD and TAS return candidates. Each has external_id, lot, plan, lot_plan, area_ha and GeoJSON geometry. SA, WA, NT and ACT answer 422 parcel_search_unsupported. Draw the boundary with updatePropertyBoundary. PICs are farmer-declared identifiers, not parcel-search inputs.

A blank state is 422 parcel_search_state_required. Put the state in place_label or location. An address that does not resolve is 422 parcel_geocode_failed. With no geocoder configured, an address is 422 parcel_geocode_unavailable. Send coordinates instead. A state service that does not answer is 422 parcel_search_unavailable.

Plain JSON, not JSON:API. Needs read access to the property's records. A property shared publicly or by link does not share its parcels. Not cached on the response. The server keeps the candidates for twelve hours so attachParcelsToProperty can store the geometry it fetched.

get/properties/{property_id}/parcel-search

Request

  • Base URL
    https://api.purplegrain.com/api/v1
  • URL
    https://api.purplegrain.com/api/v1/properties/{property_id}/parcel-search
  • Auth
    HTTP bearer

Path parameters

property_idstring required

Query parameters

latitudestring

WGS84 latitude. A value that is not a number is parcel_search_query_invalid.

longitudestring

WGS84 longitude. A value that is not a number is parcel_search_query_invalid.

addressstring

Used only when latitude and longitude are omitted. Not echoed in the response.

Response

Candidate parcels. An empty parcels array means the point hit none.

property_idstring uuid required
statestring nullable
latitudenumber

The point that was searched. An address is resolved to this and is not echoed.

longitudenumber

Example response

{
  "_meta": {
    "onboarding": {
      "skill": "pg-onboarding@1"
    }
  }
}

Changes

  • 92c4663a1266Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)

  • e285768a8f1dRevision changes
    • info

      endpoint added