Dartmouth API Developer Portal

Properties

The different types of properties available are:

There is a three level hierarchy within properties. Eg.

Here "23 Haddock Lane" is a property and is a child of "19 - 23 Haddock Lane" property. Furthermore, "19 - 23 Haddock Lane" is a child of "West Lebanon, NH" property.

Required Scopes

Scope Description
"api:facilities:properties:read" This scope is required in order to view properties Authorization of this scope is granted by the Planning, Design & Construction office

Request

GET /api/facilities/properties/{id}
GET /api/facilities/properties/

Required Headers

Authorization: Bearer {jwt}

Sample Request

https://api.dartmouth.edu/api/facilities/properties/3135
https://api.dartmouth.edu/api/facilities/properties/

Sample Return

{
    "id": "3135",
    "name": "23 Haddock Lane",
    "type": "Building",
    "building_type": null,
    "status": "Potential",
    "address": {
        "postal_code": "03784",
        "street": "23 Haddock Lane",
        "city": "West Lebanon",
        "county": "Grafton",
        "state": "NH",
        "country": null
    },
    "parent_property_id": "5088",
    "from_date": null,
    "to_date": null
}

[
    {
        "id": "0001",
        "name": "3 Wentworth Street- Baker-Berry Library",
        "type": "Building",
        "building_type": null,
        "status": "Potential",
        "address": {
            "postal_code": "03755",
            "street": "3 Wentworth Street",
            "city": "Hanover",
            "county": "Grafton",
            "state": "NH",
            "country": null
        },
        "parent_property_id": "MAIN",
        "from_date": null,
        "to_date": null
    },
    {
        "id": "0002",
        "name": "Bartlett",
        "type": "Building",
        "building_type": null,
        "status": "Potential",
        "address": {
            "postal_code": null,
            "street": null,
            "city": null,
            "county": null,
            "state": null,
            "country": null
        },
        "parent_property_id": "MAIN",
        "from_date": null,
        "to_date": null
    },
    {
        "id": "0003",
        "name": "Blunt Alum Ctr",
        "type": "Building",
        "building_type": null,
        "status": "Potential",
        "address": {
            "postal_code": "03755",
            "street": "20 N. Main Street",
            "city": "Hanover",
            "county": "Grafton",
            "state": "NH",
            "country": null
        },
        "parent_property_id": "MAIN",
        "from_date": null,
        "to_date": null
    },
    {
        "id": "3135",
        "name": "23 Haddock Lane",
        "type": "Building",
        "building_type": null,
        "status": "Potential",
        "address": {
            "postal_code": "03784",
            "street": "23 Haddock Lane",
            "city": "West Lebanon",
            "county": "Grafton",
            "state": "NH",
            "country": null
        },
        "parent_property_id": "5088",
        "from_date": null,
        "to_date": null
    }
]
Field Type Description
id string
name string
type string Possible values: Building, Site, Terrain, *
building_type string Possible values: Academic, Administrative, Athletics, Graduate Housing, Institutional Housing, Rental Commercial, Rental Housing, Student Life, Support Services, Undergrad Housing
status string Possible values: Active, Construct, Design, In preparation, Inactive, Never Built, Never Purchased, Out of Service, Pending, Plan/Study, Potential, Razed, Sold, Repurchase Option
address object
parent_property_id string ID of the parent Property
from_date string Example: "2020-04-23T00:00:00Z"
to_date string