Web Service Documentation / Categories / Property Use Services / Add Property Use

Add Property Use

Updated on July 17, 2013

Description

This web service creates a property use under a specified property based on the information provided in the XML request. It returns the unique identifier to the newly created property use and a link to the corresponding web service to retrieve it. To specify the use of default values, just omit the "value" XML tag for that particular use detail information from the XML request or omit the entire reference to the particular use detail information from the XML request altogether.

Version

22.0

HTTP Method

POST

Resource URL

/property/(propertyId)/propertyUse

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id of the property

XML Schemas

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

Example Request

The following example adds a property use to the property that has an id of 422.

POST  /property/422/propertyUse

<?xml version="1.0" encoding="UTF-8"?>
<k12School>
    <name>Broadway K-12 School</name>
    <useDetails>
        <totalGrossFloorArea units="Square Feet" currentAsOf="2010-08-13" temporary="false">
            <value>333</value>
        </totalGrossFloorArea>
        <openOnWeekends currentAsOf="2010-08-13" temporary="false">
            <value>Yes</value>
        </openOnWeekends>
        <percentCooled currentAsOf="2010-08-13" temporary="false">
            <value>0</value>
        </percentCooled>
        <percentHeated currentAsOf="2010-08-13" temporary="false">
            <value>0</value>
        </percentHeated>
        <numberOfComputers currentAsOf="2010-08-13" temporary="false">
            <value>3</value>
        </numberOfComputers>
        <cookingFacilities currentAsOf="2010-08-13" temporary="false">
            <value>Yes</value>
        </cookingFacilities>
        <isHighSchool currentAsOf="2010-08-13" temporary="false">
            <value>Yes</value>
        </isHighSchool>
        <monthsInUse currentAsOf="2010-08-13" temporary="false">
            <value>8</value>
        </monthsInUse>
        <schoolDistrict currentAsOf="2010-08-13" temporary="false">
            <value>String</value>
        </schoolDistrict>
    </useDetails>
</k12School>

Example Response

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

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