Web Service Documentation / Categories / Property Services / Edit Property

Edit Property

Updated on June 28, 2021

Description

This web service updates a property based on the information provided in the XML request. The property must already be shared with you. The service returns the unique identifier to the updated property and a link to the corresponding web service to retrieve it.

Version

23.0

HTTP Method

PUT

Resource URL

/property/(propertyId)

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request property.xsd
Response response.xsd

Example Requests

The following example updates a property that has an id of 5000036.

PUT  /property/5000036

<?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"/>
    <yearBuilt>1992</yearBuilt>
    <constructionStatus>Existing</constructionStatus>
    <grossFloorArea units="Square Feet" temporary="false">
        <value>856655</value>
    </grossFloorArea>
    <occupancyPercentage>70</occupancyPercentage>
    <isFederalProperty>true</isFederalProperty>
    <agency id="1"/>
    <federalOwner>US</federalOwner>
    <agencyDepartmentRegion>Region Test</agencyDepartmentRegion>
    <federalCampus>Campus Test</federalCampus>
    <notes><![CDATA[Permit license > 5 years old.]]></notes>
</property>

The following example updates a property that has an id of 5000037. For Canadian properties only, the XML element "isInstitutionalProperty" specifies whether the property is an institutional or commercial building. 

PUT  /property/5000037

<?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="Toronto" state="ON" postalCode="M5G1A1" country="CA"/>
     <yearBuilt>1992</yearBuilt>
     <constructionStatus>Existing</constructionStatus>
     <grossFloorArea units="Square Feet" temporary="false">
          <value>856655</value>
     </grossFloorArea>
     <occupancyPercentage>70</occupancyPercentage>
     <isFederalProperty>true</isFederalProperty>
     <agency id="1"/>
     <federalOwner>US</federalOwner>
     <agencyDepartmentRegion>Region Test</agencyDepartmentRegion>
     <federalCampus>Campus Test</federalCampus>
     <isInstitutionalProperty>true</isInstitutionalProperty>
     <notes><![CDATA[Permit license > 5 years old.]]></notes>
</property>

Example Response

The following example indicates that the property was successfully updated.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <id>5000036</id>
    <links>
        <link httpMethod="GET" link="/property/5000036" linkDescription="This is the GET url for this Property."/>
    </links>
</response>
TEST