notification/list

Gets the list of notifications for device.

Authorization

Access JSON Web Token (GetDeviceNotification)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "deviceId": {string},
    "start": {datetime},
    "end": {datetime},
    "notification": {string},
    "sortField": {string},
    "sortOrder": {string},
    "take": {integer},
    "skip": {integer}
}

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: notification/list
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
deviceIdYesstringDevice unique identifier.
startNodatetimeStart UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601) to filter notifications.
endNodatetimeEnd UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601) to filter notifications.
notificationNostringFilter by command name.
sortFieldNostringResult list sort field.
sortOrderNostringResult list sort order. Available values are ASC and DESC. The sortField should be specified.
takeNointegerNumber of records to take from the result list. If not specified 100 records will be taken.
skipNointegerNumber of records to skip from the result list. If not specified 0 records will be skipped.

Response Topic and Payload

Topic

dh/response/notification/list@{clientId}

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "status": {string},
    "notifications": [{
        "id": {long},
        "notification": {string},
        "timestamp": {datetime},
        "deviceId": {string},
        "networkId": {integer},
        "parameters": {object}
    }]

}

Payload Parameters

Property NameTypeDescription
actionstringAction name: notification/list
requestIdobjectRequest unique identifier as specified in the request message.
statusstringOperation execution status (success or error).
notificationsarrayThe array of notifications.
notificationobjectAn inserted DeviceNotification resource.
notification.idlongNotification identifier.
notification.notificationstringNotification name.
notification.timestampdatetimeNotification UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
notification.deviceIdstringAssociated device identifier.
notification.networkIdintegerAssociated network identifier.
notification.parametersobjectNotification parameters, a JSON object with an arbitrary structure.