Web Service Documentation / Categories / Property Services / Get Property

Get Property

Updated on June 28, 2021

Description

This web service retrieves information for a specific property. The property must already be shared with you. This service can also be used for to retrieve information on a building.

Version

18.0

HTTP Method

GET

Resource URL

/property/(propertyId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request None
Response property.xsd

Example Request

The following example retrieves the information for a property that has an id of 56345.

GET  /property/56345

Example Responses

The following example returns the property information for the property with the id of 56345.

<?xml version="1.0" encoding="UTF-8"?>
<property>
    <name>8041- Richmond Road - Score 58</name>
    <primaryFunction>Refrigerated Warehouse</primaryFunction>
    <address address1="5300 Richmond Road" city="Bedford Heights" postalCode="44146" state="OH" country="US"/>
    <numberOfBuildings>1</numberOfBuildings>
    <yearBuilt>1992</yearBuilt>
    <constructionStatus>Existing</constructionStatus>
    <grossFloorArea units="Square Feet" temporary="false">
        <value>856655</value>
    </grossFloorArea>
    <occupancyPercentage>10</occupancyPercentage>
    <isFederalProperty>true</isFederalProperty>
    <agency name="Advisory Council on Historic Preservation (ACHP)" code="ACHP" id="1" country="US"/>
    <agencyDepartmentRegion>region update</agencyDepartmentRegion>
    <federalCampus>campus update</federalCampus>
    <notes><![CDATA[Permit license > 5 years old.]]></notes>
    <accessLevel>Read Write</accessLevel>
    <audit>
        <createdBy>DUNAYT</createdBy>
        <createdByAccountId>-14</createdByAccountId>
        <createdDate>2012-08-16T17:04:57-04:00</createdDate>
        <lastUpdatedBy>DUNAYT</lastUpdatedBy>
        <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
        <lastUpdatedDate>2012-08-16T17:09:35-04:00</lastUpdatedDate>
    </audit>
</property>

The following example returns the property information for the property with the id of 56345. For Canadian properties only, the XML element "isInstitutionalProperty" specifies whether the property is an institutional or commercial building.

<?xml version="1.0" encoding="UTF-8"?>
<property>
     <name>Broadway School</name>
     <address address1="123 rue Main Street" city="Toronto" state="ON" postalCode="M5G1A1" country="CA"/>
     <numberOfBuildings>1</numberOfBuildings>
     <constructionStatus>Existing</constructionStatus>
     <primaryFunction>K-12 School</primaryFunction>
     <yearBuilt>2000</yearBuilt>
     <grossFloorArea units="Square Feet" temporary="false" default="N/A">
          <value>10000</value>
     </grossFloorArea>
     <occupancyPercentage>80</occupancyPercentage>
     <isFederalProperty>false</isFederalProperty>
     <isInstitutionalProperty>false</isInstitutionalProperty>
     <notes><![CDATA[Permit license > 5 years old.]]></notes>
     <audit>
          <createdBy>DUNAYT</createdBy>
          <createdByAccountId>-14</createdByAccountId>
          <createdDate>2012-08-16T17:04:57-04:00</createdDate>
          <lastUpdatedBy>DUNAYT</lastUpdatedBy>
          <lastUpdatedByAccountId>-14</lastUpdatedByAccountId>
          <lastUpdatedDate>2012-08-16T17:09:35-04:00</lastUpdatedDate>
     </audit>
</property>
TEST