Help Center> IoT Device Access> SDK Reference> Old SDKs> Application Java SDK API Reference> Message Push> Pushing a Software Upgrade Result Notification
View PDF

Pushing a Software Upgrade Result Notification

Typical Scenario

After an application subscribes to software upgrade result change notifications (the notification type is swUpgradeResultNotify) on the platform, the platform sends a notification to the application when a software upgrade task is complete.

API Function

This API is used by the platform to push notifications to an application that has subscribed to software upgrade result notifications.

Note

1. When subscribing to platform management 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 handleSwUpgradeResult(NotifySwUpgradeResultDTO body)

Class

PushMessageReceiver

Parameter Description

NotifySwUpgradeResultDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is swUpgradeResultNotify.

deviceId

Mandatory

String

body

Identifies a device.

appId

Mandatory

String

body

Identifies the application to which the device belongs.

operationId

Mandatory

String

body

Identifies a software upgrade task.

subOperationId

Mandatory

String

body

Identifies a software upgrade sub-task.

curVersion

Mandatory

String

body

Indicates the current software version of the device.

targetVersion

Mandatory

String

body

Indicates the target software version to which the device is to be upgraded.

sourceVersion

Mandatory

String

body

Indicates the source software version of the device.

swUpgradeResult

Mandatory

String

body

Indicates the software upgrade result.

  • SUCCESS: The device upgrade is successful.
  • FAIL: The device upgrade fails.

upgradeTime

Mandatory

String

body

Indicates the upgrade time.

resultDesc

Mandatory

String

body

Indicates the upgrade result description.

errorCode

Mandatory

String

body

Indicates a status error code reported by the device.

description

Mandatory

String

body

Indicates the description of the cause of error.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"swUpgradeResultNotify",
    "deviceId":"******",
    "appId":"***********",
    "operationId":"***********",
    "subOperationId":"***********",
    "curVersion":"1.3",
    "targetVersion":"1.5",
    "sourceVersion":"1.0",
    "swUpgradeResult":"SUCCESS",
    "upgradeTime":"***",
    "resultDesc":"***",
    "errorCode":"***",
    "description":"***"
}

Normal Response Example

Response:
Status Code: 200 OK
Parent topic: Message Push