Unlocks and reports

Read a Rapid Planning Report

A Rapid Planning Report your team started: generating, ready, incomplete or failed, with its outline and sections once it has them. A whole report runs to tens of thousands of characters, so read the outline (section=none), then a section at a time (section=2). An incomplete or failed report is generated again by POST /v1/reports/rpr, once a day at most.

get/v1/reports/rpr/{id}

Request

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

Path parameters

idstring required

The id POST /v1/reports/rpr answered with.

Query parameters

'none'

integer

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

Response

The report.

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.