Web Service Documentation / Categories / Meter Services / Get All Meter Identifier List

Get All Meter Identifier List

Updated on December 10, 2018

Description

This web service retrieves a list of all of the unique identifiers for all meters in a specified property. These identifiers are used to provide additional information on a meter. You must have at least read only access on the meter to view the unique identifiers.

Version

19.0

HTTP Method

GET

Resource URL

/property/(propertyId)/meter/identifier/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id of the property

XML Schemas

Request/Response Schema Name
Request None
Response additionalIdentifier.xsd

Example Request

The following example retrieves the list of all unique identifiers for a property with an id of "1234".

GET  /property/1234/meter/identifier/list

Example Response

The following example lists the links to retrieve each unique identifiers for each meter for the specified property.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link httpMethod="GET" link="/meter/676545/identifier/925276" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 1"/>
          <link httpMethod="GET" link="/meter/676545/identifier/925277" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 2"/>
          <link httpMethod="GET" link="/meter/676545/identifier/925278" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 3"/>
          <link httpMethod="GET" link="/meter/676546/identifier/925279" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 1"/>
          <link httpMethod="GET" link="/meter/676546/identifier/925280" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 2"/>
          <link httpMethod="GET" link="/meter/676546/identifier/925281" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 3"/>
          <link httpMethod="GET" link="/meter/676547/identifier/925282" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 1"/>
          <link httpMethod="GET" link="/meter/676547/identifier/925283" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 2"/>
          <link httpMethod="GET" link="/meter/676547/identifier/925284" linkDescription="This is the GET url for this Meter Additional Identifier." hint="Custom ID 3"/>
     </links>
</response>
TEST