Web Service Documentation / Categories / Building Services / Add Building

Add Building

Updated on December 10, 2018


This web service creates a building under a specified property based on the information provided in the XML request. It returns the unique identifier to the newly created building and a link to the corresponding web service to retrieve it.



HTTP Method


Resource URL



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

Authorization Required



Parameter Name Description
propertyId Id of property to add the building to

XML Schemas

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

Example Request

The following example creates a new building under a property that has an id of 923.

POST  /property/923/building

<?xml version="1.0" encoding="UTF-8"?> <building> <name>8041- Richmond Road - Score 58</name> <address address1="5300 Richmond Road" city="Bedford Heights" postalCode="44146" state="OH" country="US"/> <constructionStatus>Existing</constructionStatus> <primaryFunction>Refrigerated Warehouse</primaryFunction> <yearBuilt>1992</yearBuilt> <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> </building>

Example Response

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

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