Web Service Documentation / Categories / Property Use Services / Edit Use Details

Edit Use Details

Updated on July 17, 2013

Description

This web service updates a specific set of use details based on the information provided in the XML request. The update is performed by creating a revision history. It returns the unique identifier to the use details 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

23.0

HTTP Method

POST

Resource URL

/propertyUse/(propertyUseId)/useDetails

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
propertyUseId Id of the property use

XML Schemas

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

Example Request

The following example updates the gross floor area for a property use that has an id of 14. The update is performed by creating a revision history.

POST  /propertyUse/14/useDetails

<?xml version="1.0" encoding="UTF-8"?>
<totalGrossFloorArea units="Square Feet" temporary="false" currentAsOf="2001-08-01">
    <value>129876</value>
</totalGrossFloorArea>

Example Response

The following example returns the information for the use details.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <id>1766</id>
    <links>
        <link httpMethod="GET" link="/useDetails/1766" linkDescription="This is the GET url for this Use Details."/>
    </links>
</response>
LIVE