Web Service Documentation / Categories / Property Use Services / Get Custom Use Details Revision History

Get Custom Use Details Revision History

Updated on August 28, 2023

Description

This web service retrieves the custom use details revision history for a specific property. The corresponding property must be already shared to you.

Version

23.0

HTTP Method

GET

Resource URL

/customUse/(propertyId)/detailRevisions?currentAsOfStart=(YYYY-MM-DD)&currentAsOfEnd=(YYYY-MM-DD)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id of the property

XML Schemas

Request/Response Schema Name
Request None
Response useDetailsRevisions.xsd

Example Request

The following example retrieves the custom use details information for a property that has an id of 14. If you want to just retrieve use detail records that cover a date range of January 1st, 2002 to December 31st, 2002 then the following URL parameters should be provided: currentAsOfStart=2002-01-01¤tAsOfEnd=2002-12-31

GET  /customUse/14/detailRevisions

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<useDetails>
     <customUseDetail1 dataType="numeric" id="130086500" currentAsOf="2000-01-01" temporary="false" default="No">
          <customName>test detail</customName>
          <value>55</value>
     </customUseDetail1>
     <customUseDetail1 dataType="numeric" id="130086600" currentAsOf="2005-01-01" temporary="false" default="No">
          <customName>test detail</customName>
          <value>90</value>
     </customUseDetail1>
     <customUseDetail2 units="Square Feet" dataType="numeric" id="130086501" currentAsOf="2000-01-01" temporary="false" default="No">
          <customName>test detail 2</customName>
          <value>120</value>
     </customUseDetail2>
</useDetails>
TEST