Web Service Documentation / Categories / Property Services / Add Property

Add Property

Updated on June 28, 2021

Description

This web service creates a property for a specific Portfolio Manager user based on the information provided in the XML request and establishes all of the necessary sharing permissions between you and the Portfolio Manager user. It returns the unique identifier to the newly created property and a link to the corresponding web service to retrieve it.

Version

23.0

HTTP Method

POST

Resource URL

/account/(accountId)/property

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
accountId Id to the account that the property is to be added to

XML Schemas

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

Example Requests

The following example creates a new property that belongs to an account that has an id of 53434.

POST  /account/53434/property

<?xml version="1.0" encoding="UTF-8"?>
<property>
    <name>Broadway School</name>
    <primaryFunction>K-12 School</primaryFunction>
    <address address1="12321 Main Street" city="Arlington" postalCode="22201" state="VA" country="US"/>
    <yearBuilt>2000</yearBuilt>
    <constructionStatus>Existing</constructionStatus>
    <grossFloorArea temporary="false" units="Square Feet">
        <value>10000</value>
    </grossFloorArea>
    <occupancyPercentage>80</occupancyPercentage>
    <isFederalProperty>false</isFederalProperty>
    <notes><![CDATA[Permit license > 5 years old.]]></notes>
</property>

The following example creates a new property that belongs to an account that has an id of 53434 that is located in Canada. For Canadian properties only, you can specify whether the property is an institutional or commercial building using the "isInstitutionalProperty" XML element.

POST  /account/53434/property

<?xml version="1.0" encoding="UTF-8"?>
<property>
     <name>Broadway School</name>
     <primaryFunction>K-12 School</primaryFunction>
     <address address1="123 rue Main Street" city="Toronto" state="ON" postalCode="M5G1A1" country="CA"/>
     <yearBuilt>2000</yearBuilt>
     <constructionStatus>Existing</constructionStatus>
     <grossFloorArea temporary="false" units="Square Feet">
          <value>10000</value>
     </grossFloorArea>
     <occupancyPercentage>80</occupancyPercentage>
     <isFederalProperty>false</isFederalProperty>
     <notes><![CDATA[Permit license > 5 years old.]]></notes>
     <isInstitutionalProperty>false</isInstitutionalProperty>
</property>

Example Response

The following example indicates that the property was successfully created. The response also includes the new property id of 5000036 and a link to web service to retrieve the property.

<?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>
LIVE