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 Services / Add Property Identifier Value

Add Property Identifier Value

Updated on July 17, 2013

Description

This web service adds a name and value to a specific additional property identifier for a given property based on the information provided in the XML request.

Version

25.0

HTTP Method

POST

Resource URL

/property/(propertyId)/identifier

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

Example Request

The following example assigns the value "32423 / BLDG-LOT 876313" to the property identifier that has an identifier type id of 4 for the property with an id of 32423.

POST  /property/32423/identifier

<?xml version="1.0" encoding="UTF-8"?>
<additionalIdentifier>
    <additionalIdentifierType id="4"/>
    <description>EPA Standard Property ID to be used for year 2012</description>
    <value>32423 / BLDG-LOT 876313</value>
</additionalIdentifier>

Example Response

Following example indicates that the value was successfully added to the property identifier.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <id>64</id>
    <links>
        <link httpMethod="GET" link="/property/32423/identifier/64" linkDescription="This is the GET url for this Property Additional Identifier."/>
    </links>
</response>
LIVE