/property/id
This action returns an unique identifier for the requested
property. In PPW, the unique identifier for a property is the
org_property_id.
The org_property_id is required to access the /property/get and
/property/update endpoints.
Request
| Field | Description | Required |
|---|---|---|
address | Street number and name of the property | Yes |
state | State where the property is located | Yes |
city | City where the property is located | Yes |
zip | Zip where the property is located | Yes |
client_company | Client Company of the property | Yes, if it is part of the property definition |
loan_number | Loan Number of the property | Yes, if it is part of the property definition |
Use the /property/definition API action to determine if
client_company and/or loan_number is required.
Example:
{
"address": "51 Franklin Street",
"state": "MA",
"city": "Boston",
"zip": "02110"
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"address": "51 Franklin Street", "state": "MA", "city": "Boston", "zip": "02110"}' \
https://ppw.web/svc/property/id
Response
Example successful response:
{
"org_property_id": 5666
}
Errors
| Error Type | Description | Status Code |
|---|---|---|
address_invalid | The provided property address is invalid | 400 |
missing_fields | The provided data was missing fields in Custom Property Definition | 400 |
not_found | The requested property does not exist | 404 |
access_denied | Access token is invalid or expired | 401 |
scope_invalid | Client app does not have the required OAuth scope | 403 |