Meter Attribute Administration Services
This section describes the meter administration services of the Adapter Development Kit test harness composite.
GetOutageEventType
This web service queries the outage event type for a given meter. The OutageEventType is used by DeviceStatusCheck.
Input: GetOutageEventTypeInput
Part: payload
Element: GetOutageEventTypeRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the OutageEventType should be retrieved. |
Output: GetOutageEventTypeOutput
Part: payload
Element: GetOutageEventTypeResult
The value of the OutageEventType attribute for the requested meter.
Fault: See UtilityFault. Thrown when meter id is not found.
SetOutageEventType
This web service updates the outage event type for a given meter.
Input: SetOutageEventTypeInput
Part: payload
Element: SetOutageEventTypeRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the OutageEventType should be set. |
|
value |
The new value of OutageEventType to set on the meter. |
Output: SetOutageEventTypeOutput
Part: payload
Element: SetOutageEventTypeResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault: See UtilityFault. Thrown when meter id is not found.
GetLoadActionCode
This web service queries the load action code for a given meter. This is the Connect/Disconnect behavior.
Input: GetLoadActionCodeInput
Part: payload
Element: GetLoadActionCodeRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the LoadActionCode should be retrieved. |
Output: GetLoadActionCodeOutput
Part: payload
Element: GetLoadActionCodeResult
The value of the LoadActionCode attribute for the requested meter.
Fault: See UtilityFault. Thrown when meter id is not found.
SetLoadActionCode
This web service updates the load action code for a given meter.
Input: SetLoadActionCodeInput
Part: payload
Element: SetLoadActionCodeRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the LoadActionCode should be set. |
|
value |
The new value of LoadActionCode to set on the meter. |
Output: SetLoadActionCodeOutput
Part: payload
Element: SetLoadActionCodeResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault: See UtilityFault. Thrown when meter id is not found.
IsCommissioned
This web service queries the commissioning status for a given meter. This is the Commission/Decommission behavior.
Input: IsCommissionedInput
Part: payload
Element: IsCommissionedRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the Commissioned status should be retrieved. |
Output: IsCommissionedOutput
Part: payload
Element: IsCommissionedResult
The value of the Commissioned status attribute for the requested meter.
Fault: See UtilityFault. Thrown when meter id is not found.
SetCommission
This web service updates the commissioning status for a given meter.
Input: SetCommissionedInput
Part: payload
Element: SetCommissionedRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the Commissioned status should be set. |
|
value |
The new value of Commissioned status to set on the meter. |
Output: SetCommissionedOutput
Part: payload
Element: SetCommissionedResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault: See UtilityFault. Thrown when meter id is not found.
GetExecutionStatus
This web service queries the status of the property controlling the overall execution of the command.
Input: GetExecutionStatusInput
Part: payload
Element: GetExecutionStatusRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the ExecutionStatus should be retrieved. |
Output: GetExecutionStatusOutput
Part: payload
Element: GetExecutionStatusResult
The value of the ExecutionStatus attribute for the requested meter.
Fault: See UtilityFault. Thrown when meter id is not found.
SetExecutionStatus
This web service updates the property controlling the overall completion of the command.
Input: SetExecutionStatusInput
Part: payload
Element: SetExecutionStatusRequest
|
Parameter |
Description |
|---|---|
|
id |
The ID for the meter for which the ExecutionStatus should be set. |
|
value |
The new value of ExecutionStatus to set on the meter. |
Output: SetExecutionStatusOutput
Part: payload
Element: SetExecutionStatusResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault: See UtilityFault. Thrown when meter id is not found.