PRpropcode
Unlocks and reports

Unlock a property

Unlocks a property for your team, as unlocking it in PropCode does, by its title id: look the address up with GET /v1/properties first, so a credit is never spent on the wrong match. creditType picks the credit: pro (the default) gives the Pro report (currently NSW CDC only) and the Rapid Planning Report (outside NSW, the Rapid Planning Report alone), spending Max's daily allowance first, then your Property Packs; cdc and rpr spend the credits of a plan from before Core and Pro, for the CDC report (NSW) or the Rapid Planning Report. It spends one credit, and only spendCredit: true lets it. A property your team has already unlocked costs nothing. Test keys unlock the samples without spending.

post/v1/unlocks

Request

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

Request body

titlestring required

The title id, from GET /v1/properties. Look the address up first, so a credit is never spent on the wrong match.

jurisdictionstring

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

creditType'pro' | 'cdc' | 'rpr'

The credit to spend, from GET /v1/credits. pro (the default): the Pro report (currently NSW CDC only) and the Rapid Planning Report. cdc: the CDC report, with a CDC report credit from a plan from before Core and Pro. rpr: the Rapid Planning Report, with a Rapid Planning Report credit from such a plan.

spendCreditunknown required

Response

The property, unlocked.

object'unlock' required
product'pro' | 'cdc' | 'rpr' required

What the team holds the property as: the creditType spent.

spentboolean required

Whether this request spent a credit: false when your team had already unlocked the property, and for a sample property's CDC report, which is free.

paidWith'daily_allowance' | 'pack'

What a Pro credit came from, when one was spent: Max's daily allowance or a pack.

sampleunknown
shareUrlstring

On a Pro unlock in NSW, the Pro report's share link: anyone who has it can read the report, without signing in. Elsewhere, share the Rapid Planning Report's own.

Changes

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