Read the planning report
An unlocked property's planning report (in PropCode, the Pro report): for each land use, whether it can be built under each pathway and by which way, each pathway's rules, and, on a property your team holds Pro on, how sure each answer is. It covers complying development in NSW (nsw-cdc) for now, so another state's jurisdiction answers unsupported_jurisdiction, and new pathways arrive as new entries in the same shape. Give landUse to narrow it to one land use and its rules. A rule's contentUrl gives its clause's text (GET /v1/citations/…). A Pro or a CDC report unlock reads it. Free once the property is unlocked.
Request
- Base URLhttps://app.propcode.com.au/api
- AuthHTTP bearer
Query parameters
The property's title id, as GET /v1/properties gives it, with its jurisdiction. NSW: lot/plan (5008/DP752015), lot/section/plan (10/10/DP979849) or a strata plan (SP58841); for several lots, join their ids with +: 10/DP503890+11/DP503890. VIC: lot\plan (1001\PS340516). ACT: suburb, block and section (ACTON Block 11 Section 67). TAS: volume and folio (Volume 100007 Folio 1), or CID or PID.
The state: nsw (the default), vic, act or tas. Complying development answers are NSW only.
A land use's id, or up to 10 separated by commas, from GET /v1/land-uses, each one a pathway can deliver: the report narrows to them, their answers and the rules behind them.
summary: each land use's verdict, with only its eligible ways and alterations and their figures, and no rules unless rules is true: about a quarter of the full report. full, the default: every way and alteration, with the rules.
false: leave out each pathway's rules, for the answers alone, a much smaller report. Rules come unless false; with view=summary, only when true.
Response
The report.
Changes
No recorded changes to this operation across all 1 revision of this API.