Pushing a Device Model Deletion Notification

Typical Scenario

After an application subscribes to device model deletion notifications (the notification type is deviceModelDeleted) on the platform, the platform sends a notification to the application when a device product model is deleted from the platform.

API Function

This API is used by the platform to push notifications to an application that has subscribed to device model deletion notifications.

Note

1. When subscribing to platform service data, an application must subscribe to the specified callback URL in the API description. The server and port in the callback URL are the public IP address and specified port of the application.

2. An application receives the content of a push message by inheriting the PushMessageReceiver class and overriding the callback API.

3. If the callback URL is not the address of the application, the application must implement the original callback API. For details on the API content, see Message Push in the Northbound API Reference.

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver

Callback API

void handleDeviceModelDeleted(NotifyDeviceModelDeletedDTO body)

Class

PushMessageReceiver

Parameter Description

NotifyDeviceModelDeletedDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is deviceModelDeleted.

appId

Mandatory

String

body

Uniquely identifies an application. This parameter is used to identify an application that can call open APIs provided by the platform.

deviceType

Mandatory

String

body

Indicates the device type.

manufacturerName

Mandatory

String

body

Indicates the name of the manufacturer of the device model.

manufacturerId

Mandatory

String

body

Identifies the manufacturer of the device model.

model

Mandatory

String

body

Indicates the device model.

protocolType

Mandatory

String

body

Indicates the protocol used by the device. The value options are CoAP, huaweiM2M, Z-Wave, ONVIF, WPS, Hue, WiFi, J808, Gateway, ZigBee, and LWM2M.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"deviceModelAdded",
    "appId":"*****",
    "deviceTyp ":"*************",
    " manufacturerName":"*************",
    "manufacturerId ":"*************",
    "model":"*************",
    "protocolType":"*************"
}

Normal Response Example

Response:
Status Code: 200 OK