Web Service Documentation / Categories / Property Use Services / Edit Custom Use Detail - Revision

Edit Custom Use Detail - Revision

Updated on August 28, 2023

Description

This web service updates a specific custom use detail 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 custom use detail and a link to the corresponding web service to retrieve it. The corresponding property must already be shared to you.

A maximum of 2 custom use details can be created for a property. To learn more, please reference this FAQ.

Version

22.0

HTTP Method

POST

Resource URL

/customUse/(propertyId)/details

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 customUse.xsd
Response response.xsd

Example Request

The following example updates a specific custom use detail for a property that has an id of 11. This update creates a revision history.

POST  /customUse/11/details

<?xml version="1.0" encoding="UTF-8"?>
<customUseDetail1 currentAsOf="2000-01-01" temporary="false" default="No">
     <value>55</value>
     <customName>test detail</customName>
</customUseDetail1>

Example Response

The following example returns the information for the custom use detail.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="130086500" httpMethod="GET" link="/customUse/details/130086500" linkDescription="This is the GET url for this Custom Use Detail."/>
     </links>
</response>
LIVE