/workorder/fields

This action returns a list of all work order fields that can be set for a work order through the API.

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/workorder/fields

Response

The response is a JSON object. The keys in the object are canonical names of the work order fields and the values provide information about the work order corresponding work order fields.

Example response:

{
  "wo_number": {
    "name": "WO #",
    "type": "text",
    "source": "report_info"
  },
  "org_wo_num": {
    "name": "PPW #",
    "type": "text",
    "source": "report_info"
  },
  "address": {
    "name": "Address",
    "type": "text",
    "source": "report_info"
  },
  "state": {
    "name": "State",
    "type": "dropdown",
    "options": {
      "2": "AK",
      "1": "AL",
      "4": "AR",
      "3": "AZ",
      .
      .
      .
      "45": "VT",
      "47": "WA",
      "49": "WI",
      "48": "WV",
      "50": "WY"
    },
    "source": "report_info"
  },
  "city": {
    "name": "City",
    "type": "text",
    "source": "report_info"
  },
  "zip": {
    "name": "Zip",
    "type": "text",
    "source": "report_info"
  },
  "loan_number": {
    "name": "Loan Number",
    "type": "text",
    "source": "report_info"
  },
  "work_type": {
    "name": "Work Type",
    "type": "dropdown",
    "options": {
      "28810": "Bid Approval",
      "28812": "Initial Secure",
      "28813": "Inspection",
      "28814": "Maid Service",
      "28815": "Winterization"
    },
    "source": "report_info"
  },
  "category": {
    "name": "Category",
    "type": "dropdown",
    "options": {
      "1": "Preservation"
    },
    "source": "report_info"
  },
  "client_company": {
    "name": "Client Company",
    "type": "dropdown",
    "options": {
      "12345": "A2Z",
      "12344": "Altisource",
      "12111": "Core Logic",
      "12112": "Field Asset Services",
      "12114": "MCS",
      "12347": "Wells Fargo"
    },
    "source": "report_info"
  },
  "customer": {
    "name": "Customer",
    "type": "dropdown",
    "options": {
      "6286": "Bank of America",
      "6287": "Fannie Mae",
      "6285": "Wells Fargo"
    },
    "source": "report_info"
  },
  "mortgager": {
    "name": "Mortgager",
    "type": "text",
    "source": "report_info"
  },
  "lock_code": {
    "name": "Lock Code",
    "type": "text",
    "source": "report_info"
  },
  "key_code": {
    "name": "Key Code",
    "type": "text",
    "source": "report_info"
  },
  "date_received": {
    "name": "Date Received",
    "type": "date",
    "source": "report_info"
  },
  "start_date": {
    "name": "Start Date",
    "type": "date",
    "source": "report_info"
  },
  "date_due": {
    "name": "Date Due",
    "type": "date",
    "source": "report_info"
  },
  "date_due_client": {
    "name": "Date Due Client",
    "type": "date",
    "source": "report_info"
  },
  "date_complete": {
    "name": "Date Complete",
    "type": "date",
    "source": "report_info"
  },
  "date_cancel": {
    "name": "Date Cancel",
    "type": "date",
    "source": "report_info"
  },
  "bg_checkin_provider": {
    "name": "Mobile Background Checkin Provider",
    "type": "dropdown",
    "options": {
      "ags": "Aspen Grove Solutions",
      "sl": "ServiceLink"
    },
    "source": "report_info_values"
  },
  "inspectors": {
    "name": "Contractor",
    "type": "array",
    "options": {
      "47003": "Huxely, Aldus",
      "47004": "Las, Zok",
      "45592": "Orwell, George",
      "47007": "Thatchell, March"
    },
    "source": "report_inspectors"
  },
  "comments": {
    "name": "Comments",
    "type": "text",
    "source": "report_info"
  },
  "missing_data": {
    "name": "Missing Data",
    "type": "dropdown",
    "options": {
      "1": "Yes",
      "0": "No"
    },
    "source": "report_info"
    },
  "missing_data_comment": {
    "name": "Missing Data Comment",
    "type": "text",
    "source": "report_info"
  },
  "review_asap": {
    "name": "Need Reviewed ASAP",
    "type": "dropdown",
    "options": {
      "1": "Yes",
      "0": "No"
    },
    "source": "report_info"
  },
  "loan_type": {
    "name": "Loan Type",
    "type": "dropdown",
    "options": {
      "10": "Bankruptcy",
      "4": "Conventional",
      "2": "FAMT",
      "1": "FHA",
      "8": "FHLMC",
      "7": "FNMA",
      "3": "FNVA",
      "12": "Wargo"
    },
    "source": "report_info"
  },
  "work_items": {
    "name": "Work Order Item Details",
    "type": "array",
    "options": {
      "42921": "Locks-Padlocks",
      "42933": "Locks",
      "42926": "Debris Exterior",
      "42927": "Basements / Pools Needing Pumped",
      "42929": "Trip Charge",
      "42930": "Initial Grass Cut",
      "42931": "Grass Recut",
      "42932": "Inspection"
    },
    "source": "report_line_items"
  }
}