Meter Administration Services
This section describes the meter administration services of the Adapter Development Kit test harness composite.
AddMeters
This web service adds a set of meters to the in-memory data store. This will not permanently add it to the control file.
Input: AddMetersInput
Part: payload
Element: AddMetersRequest
Parameter
Description
id
The identification code for the meter.
utility
An informational string.
serviceType
One of the valid ServiceType values (see schema). "Electric" is the only option at this time.
isCommissioned
Whether or not the meter is in a commissioned state.
loadActionCode
One of the possible LoadActionCode values used in Connect and Disconnect (see schema).
outageEventType
One of the possible OutageEventType values used in Device Status Check (see schema).
executionStatus
One of the possible ExecutionStates (see schema). These values control how the meter will respond to commands.
updateIfExisting
Whether or not to update the meter with the provided values if it already exists in the index.
Comment
An informational string describing the purpose of the meter.
Channels
A listing of unit of measures supported by this meter.
uomCode
A code describing the unit of measure for the channel.
uomName
A short string containing the name of the unit of measure.
decimals
The number of digits to the right of the decimal that should be generated when reading the meter.
description
A longer description of the unit of measure.
Output: AddMetersOutput
Part: payload
Element: AddMetersResult
Whether or not each meter was added to the index.
Fault: See UtilityFault.
RemoveMeter
This web service removes a meter from the in-memory data store. This will not permanently remove it from the control file.
Input: RemoveMeterInput
Part: payload
Element: RemoveMeterRequest
Parameter
Description
id
The ID for the meter to be removed.
Output: RemoveMeterOutput
Part: payload
Element: RemoveMeterResult
Whether or not the meter was removed from the index.
Fault: See UtilityFault. Thrown when meter id is not found.
AddMeterChannel
This web service adds a new channel to a single meter.
Input: AddMeterChannelInput
Part: payload
Element: AddMeterChannelRequest
Parameter
Description
id
The identification code for the meter.
uomCode
A code describing the unit of measure for the channel.
uomName
A short string containing the name of the unit of measure.
decimals
The number of digits to the right of the decimal that should be generated when reading the meter.
description
A longer description of the unit of measure.
Output: AddMeterChannelOutput
Part: payload
Element: AddMeterChannelResult
Whether or not the channel was added to the index.
Fault: See UtilityFault. Thrown when meter id is not found.
RemoveMeterChannel
This web service removes a Channel from a meter.
Input: RemoveMeterChannelInput
Part: payload
Element: RemoveMeterChannelRequest
Parameter
Description
id
The ID for the meter to be removed.
uomCode
A code describing the unit of measure for the channel.
uomName
A short string containing the name of the unit of measure.
These three parameters are combined to locate a unique channel
Output: RemoveMeterChannelOutput
Part: payload
Element: RemoveMeterChannelResult
Whether or not the channel was removed from the meter.
Fault: See UtilityFault. Thrown when meter id is not found.
ReadScalarMeter
This web service generates a scalar reading for each channel of a given meter.
Input: ReadScalarMeterInput
Part: payload
Element: ReadScalarMeterRequest
Parameter
Description
id
The ID for the meter to be read.
Output: ReadScalarMeterOutput
Part: payload
Element: ReadScalarMeterResult
Zero or more scalar readings for the given meter.
Parameter
Description
uomCode
A code describing the unit of measure for the channel.
uomName
A short string containing the name of the unit of measure.
decimals
The number of digits to the right of the decimal that should be generated when reading the meter.
description
A longer description of the unit of measure.
value
A random number representing the scalar reading.
Fault: See UtilityFault. Thrown when meter id is not found.