Web Service Documentation / Categories / Building Services / Edit Building

Edit Building

Updated on July 17, 2013

Description

This web service updates a building based on the information provided in the XML request. It returns the unique identifier to the updated building and a link to the corresponding web service to retrieve it.

Version

9.0

HTTP Method

PUT

Resource URL

/building/(buildingId)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
buildingId Id to the building

XML Schemas

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

Example Request

The following example updates a building that has an id of 786.

PUT  /building/786

<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>Notes</notes> </building>

Example Response

The following example indicates that the building was updated successfully.

<response status="Ok">
    <id>786</id>
    <links>
        <link httpMethod="GET" link="/building/786"
              linkDescription="This is the GET url for this Property."/>
    </links>
</response>
TEST