v1

latestOpenAPI 3.1.02026-08-04123846.7 KB

Property

Return the encrypted PDF report for a property.

The PID is first resolved into assessment area (AA) code, jurisdiction code and roll number. These identifiers are required by the legacy Landcor SOAP webservice, which returns a base64-encoded, password protected PDF. A 404 error is returned when the PID cannot be resolved, while a 502 error indicates that the legacy webservice either rejected the request or responded without a valid PDF payload.

``use_test_credentials`` is set when the caller presented a TEST token so
the legacy webservice is authenticated with the TEST credential set.

get/property/{pid}/report/pdf

Path parameters

pidstring required

Property identifier in format xxx-xxx-xxx

Response

Successful Response

pidstring required

Property identifier in format xxx-xxx-xxx

aa_codeinteger required

Assessment area code resolved from the PID.

j_codeinteger required

Jurisdiction code resolved from the PID.

roll_numberstring required

Roll number resolved from the PID.

encrypted_pdfstring required

Base64-encoded, password-protected PDF payload from the legacy webservice.

valuationnumber nullable

Market value of the property as reported by the legacy webservice.

Example response

{
  "pid": "xxx-xxx-xxx",
  "aa_code": 10,
  "j_code": 20,
  "roll_number": "01234567890",
  "valuation": 732000
}