/workorder/search
This action returns a list of work orders matching the address specified in the request.
Request
| Field | Description | Required |
|---|---|---|
org_wo_num | PPW number | No |
wo_number | Work order number | No |
loan_number | Loan number | No |
address | Street number and name | No |
city | City | No |
state | State | No |
zip | Zip | No |
offset | Search offset | No |
All parameters are optional, but the request must have at least one
parameter other than offset.
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/workorder/search
Response
| Field | Description | Type |
|---|---|---|
work_orders | List of matching work orders. | array |
next | Indicates there are more matching work orders. | object |
Each item in the work_orders array contains the unique identifier
— report_id; this identifier is required for accessing other
actions in this service.
The action returns at most 100 matching work orders per request. If
there are more than 100 matching work orders, the response will
contain the next field. Use the next.offset field to retrieve the
next 100 matching work orders.
Example successful response:
{
"work_orders": [
{
"report_id": 10601,
"org_property_id": 5666,
"address": "51 Franklin Street",
"city": "Boston",
"state": "MA",
"zip": "02110",
"loan_number": "FHA8918818",
"work_type": 28811,
"date_received": "20201201"
},
{
"report_id": 10595,
"org_property_id": 5666,
"address": "51 Franklin Street",
"city": "Boston",
"state": "MA",
"zip": "02110",
"loan_number": "FHA8918818",
"work_type": 28811,
"date_received": "20201115"
},
.
.
.
],
"next": {
"address": "51 Franklin Street",
"city": "Boston",
"state": "MA",
"zip": "02110",
"offset": 100
}
}
Errors
| Error Type | Description | Status |
|---|---|---|
invalid_search | Search parameters not specified | 400 |