Skip to content

Latest commit

 

History

History
73 lines (61 loc) · 3.34 KB

File metadata and controls

73 lines (61 loc) · 3.34 KB
title slug excerpt hidden metadata createdAt updatedAt
notification/get
notificationget
false
image robots
index
Sat Jul 15 2017 08:16:18 GMT+0000 (Coordinated Universal Time)
Tue Nov 07 2017 23:34:49 GMT+0000 (Coordinated Universal Time)

Gets information about the notification.

Request Message

Authorization

Access JSON Web Token (GetDeviceNotification)

Message Representation

{
    "action": {string},
    "requestId": {object},
    "deviceId": {string},
    "notificationId": {long}
}

Message Parameters

Property Name Required Type Description
action Yes string Action name: notification/get
requestId No object Request unique identifier, will be passed back in the response message.
deviceId Yes string Device unique identifier.
notificationId Yes long Notification unique identifier.

Server Message

Message Representation

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

Message Parameters

Property Name Type Description
action string Action name: notification/get
status string Operation execution status (success or error).
requestId object Request unique identifier as specified in the request message.
notification object An inserted DeviceNotification resource.
notification.id long Notification identifier.
notification.notification string Notification name.
notification.timestamp datetime Notification UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
notification.deviceId string Associated device identifier.
notification.networkId integer Associated network identifier.
notification.parameters object Notification parameters, a JSON object with an arbitrary structure.