announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Web Service Documentation / Categories / Property Use Services / Get Custom Use Detail

Get Custom Use Detail

Updated on August 28, 2023

Description

This web service retrieves specific use detail information for a given custom use detail. The corresponding property must already be shared with you.

Version

25.0

HTTP Method

GET

Resource URL

/customUse/details/(detailsId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
useDetailsId Id of the custom use detail

XML Schemas

Request/Response Schema Name
Request None
Response customUse.xsd

Example Request

The following example retrieves the custom use detail information that has an id of 145.

GET  /customUse/details/145

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<customUseDetail1 dataType="numeric" id="145" 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>
TEST