Unlocks and reports

Generate the Rapid Planning Report

Starts generating an unlocked property's Rapid Planning Report, of the kind reportType names: every land use, one land use (landUse), or subdivision. It's generated from the property's planning documents, in NSW, VIC, ACT and TAS, and takes a few minutes, so this answers at once with its id; read GET /v1/reports/rpr/{id} until it's ready. Once the property is unlocked (Pro, or a Rapid Planning Report credit), its Rapid Planning Reports cost nothing more: every kind, for every land use. Your team holds one report of each kind on a property, and one for each land use, generated the first time anyone in the team asks for it. Asking again, with any of the team's keys or in PropCode, answers with that report (alreadyGenerated: true), unless it's incomplete or failed, which generates it again (once a day at most). Live keys only.

post/v1/reports/rpr

Request

Base URL
https://app.propcode.com.au/api
Auth
HTTP bearer

Query parameters

'none'

integer

One section, by its number in outline, or none for the outline alone. Every section unless given.

Request body

titlestring required

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.

jurisdictionstring

The state: nsw (the default), vic, act or tas. Complying development answers are NSW only.

reportType'multiple_land_uses' | 'single_land_use' | 'subdivision'

multiple_land_uses (the default): the rules for every land use. single_land_use: the rules for one land use, named by landUse. subdivision: the rules for subdividing the lot.

landUsestring

A land use's id, from GET /v1/land-uses: required for single_land_use, and taken by no other type.

Response

The report, generating or ready.

object'rpr' required

idstring required

The report's id, for GET /v1/reports/rpr/{id}.

reportType'multiple_land_uses' | 'single_land_use' | 'subdivision' required

landUsestring

The land use's name, for single_land_use.

status'generating' | 'ready' | 'incomplete' | 'failed' required

generating: in progress, usually 2–5 minutes; read it again. ready: generated, with its sections. incomplete: generated with sections missing (missing lists them), and the ones it has. failed: not generated (error says why). For incomplete or failed, POST /v1/reports/rpr again generates it again, once a day at most.

alreadyGeneratedboolean

POST only. true: your team already had this report (one of each type, and one for each land use, per property), so this request generated nothing new. false: this request started generating it.

createdAtstring required

When it was started (ISO 8601).

reportUrlstring required

The report on PropCode.

shareUrlstring required

The report's share link, as PropCode's Share copies it: anyone who has it can read the report, without signing in.

missingstring[]

The sections that weren't generated, or came out cut short, when incomplete.

errorstring

What went wrong, when incomplete or failed.

Changes

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