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

Edit Use Details - Correction

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 as a correction. It returns the unique identifier to the use details and a link to the corresponding web service to retrieve it. The corresponding property must already be shared with you. 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

9.0

HTTP Method

PUT

Resource URL

/useDetails/(useDetailsId)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
useDetailsId Id of the use details

XML Schemas

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

Example Request

The following example updates the use details information that has an id of 1765. The update is performed as a correction.

PUT  /useDetails/1765

<totalGrossFloorArea units="Square Feet" temporary="false" currentAsOf="2000-08-01" id="1765"> <value>999</value> </totalGrossFloorArea>

Example Response

The following example returns the information for the space attribute.

<response status="Ok">
    <id>1765</id>
    <links>
        <link httpMethod="GET" link="/useDetails/1765"
              linkDescription="This is the GET url for this Use Details."/>
    </links>
</response>
LIVE