Web Service Documentation / Categories / Property Use Services / Get Custom Property Use
Updated on August 28, 2023
This web service returns the custom use detail information for a given property. If at least one custom use detail has not been defined then a 404 is returned. To create a new custom use detail, please see. The information includes general data about the custom property use itself and its most current custom characteristics information. The corresponding property must already be shared to you.
23.0
GET
/customUse/(propertyId)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
propertyId | Id of the property |
Request/Response | Schema Name |
---|---|
Request | None |
Response | customUse.xsd |
The following example retrieves current information for a custom property use for a property that has an id of 14.
GET /customUse/14
The following example returns the information for a custom property use if one is defined.
<?xml version="1.0" encoding="UTF-8"?>
<customUse>
<audit>
<createdBy>CARREYH</createdBy>
<createdByAccountId>-6</createdByAccountId>
<createdDate>2023-04-07T12:54:08.000-05:00</createdDate>
<lastUpdatedBy>CARREYH</lastUpdatedBy>
<lastUpdatedByAccountId>-6</lastUpdatedByAccountId>
<lastUpdatedDate>2023-04-07T12:54:08.000-05:00</lastUpdatedDate>
</audit>
<name>Entire Property Use</name>
<useDetails>
<customUseDetail1 dataType="numeric" id="130086500" currentAsOf="2000-01-01" temporary="false" default="No">
<audit>
<createdBy>CARREYH</createdBy>
<createdByAccountId>-6</createdByAccountId>
<createdDate>2023-04-21T10:18:27.000-05:00</createdDate>
<lastUpdatedBy>CARREYH</lastUpdatedBy>
<lastUpdatedByAccountId>-6</lastUpdatedByAccountId>
<lastUpdatedDate>2023-04-21T10:18:27.000-05:00</lastUpdatedDate>
</audit>
<value>55</value>
<customName>test detail</customName>
</customUseDetail1>
<customUseDetail2 units="Square Feet" dataType="numeric" id="130086501" currentAsOf="2000-01-01" temporary="false" default="No">
<audit>
<createdBy>CARREYH</createdBy>
<createdByAccountId>-6</createdByAccountId>
<createdDate>2023-04-21T10:18:28.000-05:00</createdDate>
<lastUpdatedBy>CARREYH</lastUpdatedBy>
<lastUpdatedByAccountId>-6</lastUpdatedByAccountId>
<lastUpdatedDate>2023-04-21T10:24:13.000-05:00</lastUpdatedDate>
</audit>
<value>120</value>
<customName>test detail 2</customName>
</customUseDetail2>
</useDetails>
</customUse>