Web Service Documentation / Categories / Meter Services / Add Meter Identifier Value
Updated on December 10, 2018
This web service adds a name and value to a specific additional meter identifier for a given meter based on the information provided in the XML request.
23.0
POST
/meter/(meterId)/identifier
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials | |
Content-Type | application/xml |
Yes
Parameter Name | Description |
---|---|
meterId | Id of the meter |
Request/Response | Schema Name |
---|---|
Request | additionalIdentifier.xsd |
Response | response.xsd |
The following example assigns the value "1645" to the meter identifier that has an additionalIdentifierType id of "1" for the property with a meter id of 676545. Note, only three custom identifiers are allowed per meter id. To add a second custom meter identifer, use a value of "2" for the additionalIdentifierType id. To add a third, use a value of "3".
POST /meter/676545/identifier<?xml version="1.0" encoding="UTF-8"?> <additionalIdentifier> <additionalIdentifierType id="1"/> <description>UTILITY ACCT SUBMETER 12a - MECHANICAL</description> <value>1645</value> </additionalIdentifier>
The following example indicates that the value was successfully added to the meter identifier.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<id>925276</id>
<links>
<link httpMethod="GET" link="/meter/676545/identifier/925276" linkDescription="This is the GET url for this Meter Additional Identifier."/>
</links>
</response>