Skip to content

Latest commit

 

History

History
72 lines (60 loc) · 3.48 KB

File metadata and controls

72 lines (60 loc) · 3.48 KB
title slug excerpt hidden metadata createdAt updatedAt
notification/insert
notificationinsert
false
image robots
index
Sat Jul 15 2017 08:16:57 GMT+0000 (Coordinated Universal Time)
Tue Nov 07 2017 23:39:10 GMT+0000 (Coordinated Universal Time)

Creates new device notification on behalf of device.

Request Message

Authorization

Access JSON Web Token (CreateDeviceNotification)

Message Representation

{
    "action": {string},
    "requestId": {object},
    "deviceId": {string},
    "notification": {
        "notification": {string},
        "timestamp": {datatime},
        "parameters": {object}
    }
}

Message Parameters

Property Name Required Type Description
action Yes string Action name: notification/insert
requestId No object Request unique identifier, will be passed back in the response message.
deviceId Yes string Device unique identifier.
notification Yes object A DeviceNotification resource to create.
notification.notification Yes string Notification name.
notification.timestamp No datetime Notification UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
notification.parameters No object Notification parameters, a JSON object with an arbitrary structure.

Response Message

Message Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object},
    "notification": {
        "id": {integer},
        "timestamp": {datetime}
    }
}

Message Parameters

Property Name Type Description
action string Action name: notification/insert
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 integer Notification identifier.
notification.timestamp datetime Notification UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601)).