Web Service Documentation / Categories / Meter Services / Associate Meters to a Property

Associate Meters to a Property

Updated on August 8, 2016

Description

This web service associates a set of meters to a property based on the set of meters provided in the XML request. If a set of energy meters is only provided then the association is only performed using that set of energy meters and any existing water meter associations are not affected. Similarly, if a set of water meters is only provided then the association is only performed using that set of water meters and any existing energy meter associations are not affected. All submissions overwrite/replace previous settings.

Version

24.0

HTTP Method

POST

Resource URL

/association/property/(propertyId)/meter

Header

Field Name Value Comments

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

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

Example Request

The following example associates 2 energy meters and 2 water meters to the property that has an id of 100. All meters represent the whole property.

POST  /association/property/100/meter

<?xml version="1.0" encoding="UTF-8"?>
<meterPropertyAssociationList>
    <energyMeterAssociation>
        <meters>
            <meterId>1</meterId>
            <meterId>2</meterId>
        </meters>
        <propertyRepresentation>
            <propertyRepresentationType>Whole Property</propertyRepresentationType>
        </propertyRepresentation>
    </energyMeterAssociation>
    
    <waterMeterAssociation>
        <meters>
            <meterId>10</meterId>
            <meterId>20</meterId>
        </meters>
        <propertyRepresentation>
            <propertyRepresentationType>Whole Property</propertyRepresentationType>
        </propertyRepresentation>
    </waterMeterAssociation>
    
    <wasteMeterAssociation>
        <meters>
            <meterId>100</meterId>
            <meterId>200</meterId>
        </meters>
    </wasteMeterAssociation>    
</meterPropertyAssociationList>

Example Response

The following example indicates that the association was performed successfully.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <links>
        <link httpMethod="GET" link="/association/property/100/meter" linkDescription="This is the GET url for this property meter association list."/>
    </links>
</response>
TEST