/workorder/get
This action returns work order field values for a work order. It also returns a list of all work order fields that may be set for the work order.
Request
| Field | Description | Required |
|---|---|---|
report_id | Unique identifier for the work order | Yes |
Example:
{
"report_id": 10616
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"report_id": 10616}' \
https://ppw.web/svc/workorder/get
Response
| Field | Description | Type |
|---|---|---|
report_id | Unique identifier for the work order | number |
org_property_id | Unique property identifier | number |
values | Work order fields set for the work order | object |
fields | List of all work order fields | object |
The fields object in the response contains all the work order fields
that can be set for the work order. The key in this object is the
canonical name of the work order field and the value is an object
containing information about the work order field.
Example successful response:
{
"report_id": 10616,
"org_property_id": 5666,
"values": {
"wo_number": "TN3892",
"org_wo_num": 11845,
"address": "51 Franklin Street",
"state": 21,
"city": "Boston",
"zip": "02110",
"loan_number": "",
"work_type": 28811,
"category": 0,
"client_company": 12344,
"customer": 0,
"mortgager": "",
"lock_code": "",
"key_code": "",
"date_received": "20201201",
"start_date": "00000000",
"date_due": "20201231",
"date_due_client": "00000000",
"date_complete": "00000000",
"date_cancel": "00000000",
"wo_status": "In Field",
"missing_data": 1,
"missing_data_comment": "Missing Info needed.",
"review_asap": 1,
},
"fields": {
"wo_number": {
"name": "WO #",
"type": "text"
},
"org_wo_num": {
"name": "PPW #",
"type": "text"
},
"address": {
"name": "Address",
"type": "text"
},
"state": {
"name": "State",
"type": "dropdown",
"options": {
"1": "AL",
"21": "MA",
"50": "WY",
.
.
.
}
},
"city": {
"name": "City",
"type": "text"
},
"zip": {
"name": "Zip",
"type": "text"
},
"loan_number": {
"name": "Loan Number",
"type": "text"
},
"work_type": {
"name": "Work Type",
"type": "dropdown",
"options": {
"28810": "Bid Approval",
"29055": "Boarding",
"28811": "Grass Cut",
"28812": "Initial Secure",
"28813": "Inspection"
}
},
"category": {
"name": "Category",
"type": "dropdown",
"options": {
"1": "Preservation"
}
},
"client_company": {
"name": "Client Company",
"type": "dropdown",
"options": {
"12345": "A2Z",
"12344": "Altisource",
"12111": "Core Logic",
"12112": "Field Asset Services",
"12114": "MCS",
"12115": "Safeguard",
"12113": "Service Link",
"12346": "Single Source",
"12347": "Wells Fargo"
}
},
"customer": {
"name": "Customer",
"type": "dropdown",
"options": {
"6286": "Bank of America",
"6287": "Fannie Mae",
"6285": "Wells Fargo"
}
},
"missing_data": {
"name": "Missing Data",
"type": "dropdown",
"options": {
"1": "Yes",
"0": "No"
},
},
"missing_data_comment": {
"name": "Missing Data Comment",
"type": "text",
},
"review_asap": {
"name": "Need Reviewed ASAP",
"type": "dropdown",
"options": {
"1": "Yes",
"0": "No"
},
},
"mortgager": {
"name": "Mortgager",
"type": "text"
},
"lock_code": {
"name": "Lock Code",
"type": "text"
},
"key_code": {
"name": "Key Code",
"type": "text"
},
"date_received": {
"name": "Date Received",
"type": "date"
},
"start_date": {
"name": "Start Date",
"type": "date"
},
"date_due": {
"name": "Date Due",
"type": "date"
},
"date_due_client": {
"name": "Date Due Client",
"type": "date"
},
"date_complete": {
"name": "Date Complete",
"type": "date"
},
"date_cancel": {
"name": "Date Cancel",
"type": "date"
}
}
}
Errors
| Error Type | Description | Status Code |
|---|---|---|
invalid_report_id | Unique work order identifier is invalid | 400 |
not_found | Work order does not exist | 404 |