/property/definition
This action fetches a list of the fields which are used to determine
the identity of a property, also known as its definition. In addition,
it will fetch all the metadata for those fields identical to the
format outputted by the /workorder/fields API action.
All of the fields in the definition must be sent in the request data
for the property/id API action.
Request
This request’s body must be empty.
Example:
curl -v \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
https://ppw.web/svc/property/definition
Response
A successful response returns a property definition object with following fields:
| Field | Description | Type |
|---|---|---|
definition | Array of fields that make the property definition | array |
fields | Contains information about the property definition fields | object |
Example successful response
{
"definition": [
"address",
"client_company",
"loan_number"
],
"fields": {
"address": {
"name": "Address",
"type": "text",
"source": "report_info"
},
"loan_number": {
"name": "Loan Number",
"type": "text",
"source": "report_info"
},
"client_company": {
"name": "Client Company",
"type": "dropdown",
"options": {
"32857": "America's Infomart",
"12111": "Core Logic",
"12112": "Field Asset Services",
"12114": "MCS",
"12115": "Safeguard",
"12113": "Service Link"
},
"source": "report_info"
}
}
}