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 / Connection/Share Services / Accept/Reject Pending Property Share Requests

Accept/Reject Pending Property Share Requests

Updated on July 17, 2013

Description

This web service sends an accept or reject reply to a pending property share request along with an optional note based on the information provided in the XML request.

Version

25.0

HTTP Method

POST

Resource URL

/share/property/(propertyId)

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request authorization.xsd
Response response.xsd

Example Requests

The following example accepts the share request to the property that has an id of 86.

POST  /share/property/86

<?xml version="1.0" encoding="UTF-8"?>
<sharingResponse>
     <action>Accept</action>
     <note>Your sharing request has been verified and accepted.</note>
</sharingResponse>

The following example rejects the share request to the property that has an id of 5000001.

POST  /share/property/86

<?xml version="1.0" encoding="UTF-8"?>
<sharingResponse>
     <action>Reject</action>
     <note>Your sharing request has been rejected.</note>
</sharingResponse>

Example Response

The following example shows that the share has been established to the property that has an id of 86.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>
TEST