arrow-left

All pages
gitbookPowered by GitBook
1 of 10

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

SetDeviceLifecycleStatusByChannelResponse

hashtag
Description

SetDeviceLifecycleStatusByChannelResponse returns the result of a SetDeviceLifecycleStatusByChannel request. The response contains the GatewayDeviceIdentification, MbusDeviceIdentification, DeviceLifecycleStatus and channel.SetDeviceLifecycleStatusByChannel request.

hashtag
References

XSD:

WSDL:

GetFindEventsResponse

hashtag
Description

GetFindEventsResponse returns if the result is successful from the FindEvents request. The response contains the DeviceIdentification and CorrelationUid which is received from the request.

All requests have similar response behaviour which is described in .

sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right
hashtag
References

XSD:

WSDL:

FindEvents
ResponseMessages
sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right

DisableDebugging

hashtag
Description

Disable debugging for a device. Communication with the device will be logged and made available through FindMessageLogs,

All requests have similar response behaviour which is described in ResponseMessages.

GetDisableDebuggingResponsearrow-up-right returns the result status. The response contains the DeviceIdentification and CorrelationUid which is received from the GetDisableDebuggingRequest request.

hashtag
References

XSD:

WSDL:

SetDeviceLifecycleStatusByChannel

hashtag
Description

SetDeviceLifecycleStatusBychannel is a request to set the device lifecycle status of an Mbus device, using the device identification of the Gateway device and a channel.

All requests have similar response behaviour which is described in ResponseMessages.

The returned response for the SetDeviceLifecycleStatusByChannel request is as specified in SetDeviceLifecycleStatusByChannelResponse.

hashtag
References

XSD:

WSDL:

GetGsmDiagnostic

hashtag
Description

GetGsmDiagnostic is a request to retrieve information about the communication modem of a device, such as operator, status, cellInfo and information about adjacent cells.

All requests have similar response behaviour which is described in ResponseMessages.

hashtag
References

XSD:

WSDL:

GetDevices

hashtag
Description

GetDevices is a request to get the last known relay statuses for a group of devices, so you can get an overview of statuses for a specific set of devices. The request needs the Page parameter.

All requests have similar response behaviour which is described in ResponseMessages.

hashtag
References

XSD:

WSDL:

FindMessageLogs

hashtag
Description

FindMessageLogs is a request to retrieve logged messages for a device. The request needs the DeviceIdentification and a Page number to return.

All requests have similar response behaviour which is described in ResponseMessages.

GetFindMessageLogsResponsearrow-up-right returns if the result is successful from the request. The response contains the DeviceIdentification and CorrelationUid which is received from the FindMessageLogs request.

Note: This functionality also exists in the admin device management service. It was duplicated here to be implemented asynchronously, as there is no support for asynchronous requests triggering a notification service in the admin project. As soon as asynchronous requests and notifications are implemented throughout the OSGP platform, this method should be removed in favour of the admin implementation.

hashtag
References

XSD:

WSDL:

sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right
sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right
sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right
sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right
sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right

FindEvents

hashtag
Description

FindEvents is a request to retrieve periodic events logging from a device. The request needs the DeviceIdentification, EventLogCategory, From and Until DateTime. The EventlogCategories consist off:

  • STANDARD_EVENT_LOG

  • FRAUD_DETECTION_LOG

  • COMMUNICATION_SESSION

  • M_BUS_EVENT_LOG

  • POWER_QUALITY_EVENT_LOG

  • AUXILIARY_EVENT_LOG

DSMR Chapter 4.2.1 and SMR5.1 chapters 4.2.1 and 4.2.2 describe the several events and their descriptions.

All requests have similar response behaviour which is described in .

returns if the result is successful from the request. The response contains the DeviceIdentification and CorrelationUid which is received from the FindEvents request.

hashtag
References

XSD:

WSDL:

ResponseMessages
GetFindEventsResponse
sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right

Management

Describes the actions as defined in

SmartMeteringManagement.wsdlarrow-up-right

EnableDebugging

hashtag
Description

Enable debugging for a device. Communication with the device will be logged and made available through FindMessageLogs,

All requests have similar response behaviour which is described in ResponseMessages.

GetEnableDebuggingResponsearrow-up-right returns the result status. The response contains the DeviceIdentification and CorrelationUid which is received from the GetEnableDebuggingRequest request.

hashtag
References

XSD:

WSDL:

sm-management.xsdarrow-up-right
SmartMeteringManagement.wsdlarrow-up-right