/property/get

This action returns information about the property that is stored in the PPW system.

Request

Example:

{
  "org_property_id": 5666
}

curl -v \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer ACCESS_TOKEN' \
         -d '{"org_property_id": 5666}' \
         https://ppw.web/svc/property/get

Response

The values key in the response is a JSON object that contains the property fields that are set for the property. The key in this object is the canonical name for the property field. The value is the canonical value for set for the respective property field.

The fields key in the response is a JSON object that contains a listing of all property fields that can be set for the property. The key in this object is the canonical name of the property field and the value is a JSON object that contains:

• name: Friendly name for the property field.
• type: The type of the property field.
• options: All possible values for the property field. Set only for dropdown, bool/oo and bool/yn types. The keys in this JSON object are the canonical values for the property field.

Example successful response:

{
  "address": "51 FRANKLIN ST",
  "state": "MA",
  "city": "BOSTON",
  "zip": "021101335",
  "org_property_id": 5666,
  "values": {
    "property_investor_id": "16",
    "property_gas_status": "1",
    "property_gas_last_reading": "8383",
    "property_vpr_filed": "1",
    "property_published_occupancy_date": "20201201"
  },
  "fields": {
    "property_investor_id": {
      "name": "Investor",
      "type": "dropdown",
      "options": {
        "": "",
        "5": "Fannie",
        "16": "Fargo",
        "4": "FHA",
        "14": "FHLMC",
        "15": "FNMA",
        "3": "VA"
      }
    },
    "property_gas_status": {
      "name": "Gas Status",
      "type": "bool/oo",
      "options": {
        "": "",
        "1": "On",
        "0": "Off"
      }
    },
    "property_gas_last_reading": {
      "name": "Gas Last Reading",
      "type": "text"
    },
    "property_vpr_filed": {
      "name": "VPR Filed",
      "type": "bool/yn",
      "options": {
        "": "",
        "1": "Yes",
        "0": "No"
      }
    },
    "property_flag": {
      "name": "Property Flag",
      "type": "multiselect",
      "options": {
        "": "",
        "32": "Vacant",
        "34": "InActive",
        "35": "Occupied"
      }
    },
    "property_published_occupancy_date": {
      "name": "Published Occupancy Date",
      "type": "date"
    },
    .
    .
    .
  }
}

Errors