Custom Group Management

This topic describes the API operations that are used to manage custom groups.

API list

Request method	API	Description
GET	/v1.0/illumination/group/package/create/devices	Get a list of devices that can be added to the group
POST	/v1.0/illumination/group/package	Create a custom group
GET	/v1.0/illumination/group/package/{groupPackageId}/devices	Get devices that can be modified in batches
PUT	/v1.0/illumination/group/package	Modify a custom group
DELETE	/v1.0/illumination/group/package/{groupPackageId}	Delete a custom group
GET	/v1.0/illumination/group/package	Get a list of custom groups in the space
GET	/v1.0/illumination/project/group/package	Get a list of custom groups in the project
GET	/v1.0/illumination/group/package/{groupPackageId}	Get details of a custom group
GET	/v1.0/illumination/group/package/devices	Get the list of devices in the group
POST	/v1.0/illumination/group/package/control	Control the group

Get a list of devices that can be added to the group

API description

Before you create a group, you can call this API operation to get a list of devices that can join the group.

API endpoint

GET /v1.0/illumination/group/package/create/devices

Request parameter

Parameter name	Data type	Parameter type	Description	Required
roomId	String	body	The room ID.	true
deviceSaasId	String	body	The unique device ID.	false

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "deviceSaasIds": "String[] // The value of `saasIds` for the devices"
}

Sample request

{
  "deviceSaasId": "The unique ID of the commercial lighting device",
  "roomId": "The room ID",
}

Sample response

{
  "deviceSaasIds": "The value of `saasIds` for the devices"
}

Create a custom group

API description

Create a custom group.

API endpoint

POST /v1.0/illumination/group/package

Request parameter

Parameter name	Data type	Parameter type	Description	Required
roomId	String	body	The room ID.	true
name	String	body	The name of a custom group.	true
topCategory	String	body	The first-level category.	false
deviceSaasIds	String[]	body	The value of saasId for a device.	false

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "groupPackageId": "String // The ID of a custom group",
  "taskId": "String // The number of device status. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "expiredSeconds": "long // The remaining seconds before the task expires. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "groupIds": "long[] // The ID of a device group"
}

Sample request

{
  "deviceSaasIds": "The value of `saasIds` for the devices"
  "topCategory": "The first-level category. The SaaS v1.5.0 defaults to `zm`.",
  "name": "The name of a custom group",
  "roomId": "The room ID",
}

Sample response

{
  "groupPackageId": "The ID of a custom group",
  "taskId": "The number of device status. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "expiredSeconds": "The remaining seconds before the task expires. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "groupIds": "The ID of a device group"
}

Get devices that can be modified in batches

API description

Get the devices that have and have not been added to the group. During editing, they can be removed from the group or added to the group.

API endpoint

GET /v1.0/illumination/group/package/{groupPackageId}/devices

Request parameter

Parameter name	Data type	Parameter type	Description	Required
groupPackageId	String	url	The group ID.	true

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

[
  {
    "deviceSaasId": "String // The unique ID of the commercial lighting device",
    "deviceId": "String // The device ID. Each device ID corresponds with one hardware device. Because the device is re-bound to a new point, the device ID is not unique",
    "groupJoinStatus": "int // Check whether the device has joined the group. Valid values: `0`: no. `1`: yes.",
    "devicePurposeCode": "String // The code of a device purpose"
  }
]

Sample request

{
  "groupPackageId": "The ID of a group",
}

Sample response

[
  {
    "deviceSaasId": "The unique ID of the commercial lighting device",
    "deviceId": "The device ID. Each device ID corresponds with one hardware device. Because the device is re-bound to a new point, the device ID is not unique here",
    "groupJoinStatus": "Check whether the device has joined the group. Valid values: `0`: no, and `1`: yes.",
    "devicePurposeCode": "The code of a device purpose"
  }
]

Modify a custom group

API description

Modify a custom group. You can add multiple devices to the group, and remove multiple devices from the group in the same call.

API endpoint

PUT /v1.0/illumination/group/package

Request parameter

Parameter name	Data type	Parameter type	Description	Required
roomId	String	body	The ID of a space.	true
groupPackageId	String	body	The ID of a custom group.	true
name	String	body	The name of a group.	true
deviceSaasIds	String[]	body	The value of saasId for a device.	false

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "groupPackageId": "String // The ID of a custom group",
  "taskId": "String // The number of device status. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "expiredSeconds": "long // The remaining seconds before the task expires. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "groupIds": "long[] // The ID of a device group"
}

Sample request

{
  "deviceSaasIds": "The value of `saasIds` for the devices"
  "name": "The name of a group",
  "groupPackageId": "The ID of a custom group",
}

Sample response

{
  "groupPackageId": "The ID of a custom group",
  "taskId": "The number of device status. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "expiredSeconds": "The remaining seconds before the task expires. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "groupIds": "The ID of a device group"
}

Delete a custom group

API description

Delete a custom group.

API endpoint

DELETE /v1.0/illumination/group/package/{groupPackageId}

Request parameter

Parameter name	Data type	Parameter type	Description	Required
groupPackageId	String	url	The ID of a custom group.	true

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "groupPackageId": "String // The ID of a custom group",
  "taskId": "String // The number of device status. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "expiredSeconds": "long // The remaining seconds before the task expires. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "groupIds": "long[] // The ID of a device group"
}

Sample request

{
  "groupPackageId": "The ID of a custom group"
}

Sample response

{
  "groupPackageId": "The ID of a custom group",
  "taskId": "The number of device status. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "expiredSeconds": "The remaining seconds before the task expires. If the value of null is returned, the task is completed without showing the time-consuming operation.",
  "groupIds": "The ID of a device group"
}

Get a list of custom groups in the space

API description

Get a list of custom groups in a specified space on pages.

API endpoint

GET /v1.0/illumination/group/package

Request parameter

Parameter name	Data type	Parameter type	Description	Required
roomId	String	body	The room ID.	true
page	int	body	The total number of pages.	true
pageSize	int	body	The number of items per page.	true

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "total": "int",
  "list": [
    {
      "groupPackageId": "String // The ID of a custom group",
      "roomId": "String // The room ID",
      "topCategory": "String // The code of the first-level category",
      "name": "String // The name of a custom group",
      "groupConfig": "String // Configuration of a group",
      "type": "int // The type of a device group. Valid values: `1`: empty group. `2`: standard group. `3`: combined group",
      "deviceNum": "int // The number of devices in a group",
      "dps": {},
      "joinedGroups": [
        {
          "ID": "long // The ID of a device group"
          "name": "String // The name of a device group",
          "productId": "String // The device category (product) ID",
          "category": "String // The value of `meshCategory` for a device group",
          "groupType": "int // The protocol type of a device group",
          "type": "int // The standard type of a device group. Valid values: `0`: single product group. `1`: sub-device group.",
          "localId": "String // The value of `localId` for a group",
          "meshId": "String // The value of `meshId`",
          "iconUrl": "String // The icon of a group",
          "deviceNum": "int // The number of devices",
          "localKey": "String // The localKey",
          "masterNodeId": "String // The nodeId of a master node",
          "masterDevId": "String // The value of `devId` for a master node",
        }
      ]
    }
  ]
}

Sample request

{
  "pageSize": "The number of items per page",
  "page": "The total number of pages"
  "roomId": "The room ID",
}

Sample response

{
  "total": "int",
  "list": [
    {
      "groupPackageId": "The ID of a custom group",
      "roomId": "The room ID",
      "topCategory": "The code of the first-level category",
      "name": "The name of a custom group",
      "groupConfig": "Configuration of a group",
      "type": "The type of a device group. Valid values: `1`: empty group. `2`: standard group. `3`: combined group",
      "deviceNum": "The number of devices in a group",
      "dps": {},
      "joinedGroups": [
        {
          "ID": "The ID of a device group"
          "name": "The name of a device group",
          "productId": "The device category (product) ID",
          "category": "The value of `meshCategory` for a device group",
          "groupType": "The protocol type of a device group",
          "type": "The standard type of a device group. Valid values: `0`: single product group. `1`: sub-device group.",
          "localId": "The value of `localId` for a group",
          "meshId": "The value of `meshId`",
          "iconUrl": "The icon of a group",
          "deviceNum": "The number of devices",
          "localKey": "The value of `localKey`",
          "masterNodeId": "The value of `nodeId` for a master node",
          "masterDevId": "The value of `devId` for a master node",
        }
      ]
    }
  ]
}

Get a list of custom groups in the project

API description

Get a list of custom groups in a specified project on pages.

API endpoint

GET /v1.0/illumination/project/group/package

Request parameter

Parameter	Data type	Parameter type	Description	Required
projectId	String	body	The room ID.	true
page	int	body	The total number of pages.	true
pageSize	int	body	The number of items per page.	true

Return parameter

Parameter	Data type	Description
code	Integer	The response code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "total": "int",
  "list": [
    {
      "groupPackageId": "String // The ID of a custom group",
      "roomId": "String // The room ID",
      "topCategory": "String // The code of the first-level category",
      "name": "String // The name of a custom group",
      "groupConfig": "String // Configuration of a group",
      "type": "int // The type of a device group. Valid values: `1`: empty group. `2`: standard group. `3`: combined group",
      "deviceNum": "int // The number of devices in a group",
      "dps": {},
      "joinedGroups": [
        {
          "ID": "long // The ID of a device group"
          "name": "String // The name of a device group",
          "productId": "String // The device category (product) ID",
          "category": "String // The value of `meshCategory` for a device group",
          "groupType": "int // The protocol type of a device group",
          "type": "int // The standard type of a device group. Valid values: `0`: single product group. `1`: sub-device group.",
          "localId": "String // The value of `localId` for a group",
          "meshId": "String // The value of `meshId`",
          "iconUrl": "String // The icon of a group",
          "deviceNum": "int // The number of devices",
          "localKey": "String // The localKey",
          "masterNodeId": "String // The value of `nodeId` for a master node",
          "masterDevId": "String // The value of `devId` for a master node",
        }
      ]
    }
  ]
}

Sample request

{
  "pageSize": "The number of items per page",
  "page": "The total number of pages"
  "roomId": "The room ID",
}

Sample response

{
  "total": "int",
  "list": [
    {
      "groupPackageId": "The ID of a custom group",
      "roomId": "The room ID",
      "topCategory": "The code of the first-level category",
      "name": "The name of a custom group",
      "groupConfig": "Configuration of a group",
      "type": "The type of a device group. Valid values: `1`: empty group. `2`: standard group. `3`: combined group",
      "deviceNum": "The number of devices in a group",
      "dps": {},
      "joinedGroups": [
        {
          "ID": "The ID of a device group"
          "name": "The name of a device group",
          "productId": "The device category (product) ID",
          "category": "The value of `meshCategory` for a device group",
          "groupType": "The protocol type of a device group",
          "type": "The standard type of a device group. Valid values: `0`: single product group. `1`: sub-device group.",
          "localId": "The value of `localId` for a group",
          "meshId": "The value of `meshId`",
          "iconUrl": "The icon of a group",
          "deviceNum": "The number of devices",
          "localKey": "The value of `localKey`",
          "masterNodeId": "The value of `nodeId` for a master node",
          "masterDevId": "The value of `devId` for a master node",
        }
      ]
    }
  ]
}

Get details of a custom group

API description

Get the details of a custom group.

API endpoint

GET /v1.0/illumination/group/package/{groupPackageId}

Request parameter

Parameter name	Data type	Parameter type	Description	Required
groupPackageId	String	url	The group ID.	true

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "groupPackageId": "String // The ID of a custom group",
  "roomId": "String // The room ID",
  "topCategory": "String // The code of the first-level category",
  "name": "String // The name of a custom group",
  "groupConfig": "String // Configuration of a group",
  "type": "int // The type of a device group. Valid values: `1`: empty group. `2`: standard group. `3`: combined group",
  "deviceNum": "int // The number of devices in a group",
  "dps": [
    {
      "dpCode": "String // The DP code",
      "dpName": "String // The DP name",
      "dpValueStd": "String // The current DP value",
      "property": {
        "range": "String[] // The value range of the attribute"
      },
      "propertyDetail": {},
      "mode": "String // The mode such as `ro` and `rw`. This feature is added to v1.4.3",
      "dpFrom": "String"
    }
  ],
  "joinedGroups": [
    {
      "ID": "long // The ID of a device group"
      "name": "String // The name of a device group",
      "productId": "String // The device category (product) ID",
      "category": "String // The value of `meshCategory` for a device group",
      "groupType": "int // The protocol type of a device group",
      "type": "int // The standard type of a device group. Valid values: `0`: single product group. `1`: sub-device group.",
      "localId": "String // The value of `localId` for a group",
      "meshId": "String // The value of `meshId`",
      "iconUrl": "String // The icon of a group",
      "deviceNum": "int // The number of devices",
      "localKey": "String // The localKey",
      "masterNodeId": "String // The nodeId of a master node",
      "masterDevId": "String // The value of `devId` for a master node",
    }
  ]
}

Sample request

{
  "groupPackageId": "The ID of a group",
}

Sample response

{
  "groupPackageId": "The ID of a custom group",
  "roomId": "The room ID",
  "topCategory": "The code of the first-level category",
  "name": "The name of a custom group",
  "groupConfig": "Configuration of a group",
  "type": "The type of a device group. Valid values: `1`: empty group. `2`: standard group. `3`: combined group",
  "deviceNum": "The number of devices in a group",
  "dps": [
    {
      "dpCode": "The DP code",
      "dpName": "The DP name",
      "dpValueStd": "The current DP value",
      "property": {
        "range": "The value range of the attribute"
      },
      "propertyDetail": {},
      "mode": "The mode such as `ro` and `rw`. This feature is added to v1.4.3",
      "dpFrom": "String"
    }
  ],
  "joinedGroups": [
    {
      "ID": "The ID of a device group"
      "name": "The name of a device group",
      "productId": "The device category (product) ID",
      "category": "The value of `meshCategory` for a device group",
      "groupType": "The protocol type of a device group",
      "type": "The standard type of a device group. Valid values: `0`: single product group. `1`: sub-device group.",
      "localId": "The value of `localId` for a group",
      "meshId": "The value of `meshId`",
      "iconUrl": "The icon of a group",
      "deviceNum": "The number of devices",
      "localKey": "The value of `localKey`",
      "masterNodeId": "The value of `nodeId` for a master node",
      "masterDevId": "The value of `devId` for a master node",
    }
  ]
}

Get the list of devices in the group

API description

Get the list of devices in the group.

API endpoint

GET /v1.0/illumination/group/package/devices

Request parameter

Parameter name	Data type	Parameter type	Description	Required
groupPackageId	String	body	The ID of a custom group.	true
page	int	body	The total number of pages. If the value is empty, all pages will be returned.	false
pageSize	int	body	The number of entries per page. If the value is empty, all items will be returned.	false

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

{
  "total": "int",
  "list": [
    {
      "deviceSaasId": "String // The unique ID of the commercial lighting device",
      "deviceId": "String // The device ID. Each device ID corresponds with one hardware device. Because the device is re-bound to a new point, the device ID is not unique",
      "deviceName": "String // The device name",
      "deviceType": "String // The device type. For more information, see `DeviceTypeEnum`.",
      "deviceTypeValue": "int // The value of the device type. For more information, see `DeviceTypeEnum`.",
      "topCategory": "String // The major category of the product. For more information, see the type description of `ProductCategoryEnum`.",
      "capability": "String // The device capabilities",
      "devicePower": "double // The device power",
      "deviceStatus": "String // The device status. For more information, see `DeviceAlarmTypeEnum`.",
      "deviceStatuses": "String[] // The device status. For more information, see `AlarmTypeEnum`.",
      "installTime": "long // The installation time of the device",
      "activeTime": "long // The active time of the device",
      "productId": "String // The device category (product) ID",
      "roomId": "String // The ID of the room to which the device belongs",
      "roomName": "String // The name of the room to which the device belongs",
      "pointId": "String // The ID of the location where the device is deployed",
      "ownerId": "String // The ID of the home group to which the device belongs",
      "switchInfo": [
        {
          "deviceId": "String // The ID of the smart switch device",
          "dpCode": "String // The DP code",
        }
      ],
      "properties": [
        {
          "dpCode": "String // The DP code",
          "dpName": "String // The DP name",
          "dpValueStd": "String // The current DP value",
          "property": {
            "range": "String[] // The value range of the attribute"
          },
          "propertyDetail": {},
          "mode": "String // The mode such as `ro` and `rw`. This feature is added to v1.4.3",
          "dpFrom": "String"
        }
      ],
      "masterGroupJoinStatus": "int // Indicates whether the device has joined the main group. Valid values: `0`: no. `1`: yes. `2`: a non-lighting device that has not joined the main group",
      "currentBrightness": "int // The brightness threshold of the room to which the device belongs",
      "supportGroup": "boolean // Check whether the device can be grouped",
      "switchStatus": "boolean // The switch status",
      "switchDpCode": "String // The switch DP code",
      "colourValue": "String // The color value",
      "brightPercentValue": "String // The brightness percentage value"
      "pointDeviceType": "int // The device type on the point map",
      "switchCount": "int",
      "dpFrom": "String",
      "devicePurpose": {
        "ID": "String // The ID",
        "name": "string // The name",
        "code": "String // The code"
      },
      "industryPurpose": {
        "ID": "String // The ID",
        "name": "string // The name",
        "code": "String // The code"
      },
      "x": "String // The x-axis coordinate of the location",
      "y": "String // The y-axis coordinate of the location",
      "category": "String // The second-level category of the product",
      "iconUrl": "String // The icon of a device",
      "uuID": "String // The UUID of a device"
    }
  ]
}

Sample request

{
  "pageSize": "The number of items per page. If the value is empty, all items will be returned.",
  "page": "The total number of pages. If the value is empty, all pages will be returned."
  "groupPackageId": "The ID of a custom group"
  }

Sample response

{
  "total": "int",
  "list": [
    {
    "deviceSaasId": "The unique ID of the commercial lighting device",
      "deviceId": "The device ID. Each device ID corresponds with one hardware device. Because the device is re-bound to a new point, the device ID is not unique here",
      "deviceName": "The device name",
      "deviceType": "The device type. For more information, see `DeviceTypeEnum`.",
      "deviceTypeValue": "The value of the device type. For more information, see `DeviceTypeEnum`.",
      "topCategory": "The major category of the product. For more information, see the type description of `ProductCategoryEnum`.",
      "capability": "The device capabilities",
      "devicePower": "The device power",
      "deviceStatus": "The device status. For more information, see `DeviceAlarmTypeEnum`.",
      "deviceStatuses": "The device status. For more information, see `AlarmTypeEnum`.",
      "installTime": "The installation time of the device",
      "activeTime": "The active time of the device",
      "productId": "The device category (product) ID",
      "roomId": "The ID of the room to which the device belongs",
      "roomName": "The name of the room to which the device belongs",
      "pointId": "The ID of the point where the device is located",
      "ownerId": "The ID of the home group to which the device belongs",
      "switchInfo": [
        {
          "deviceId": "The ID of the smart switch device",
          "dpCode": "The DP code",
        }
      ],
      "properties": [
        {
          "dpCode": "The DP code",
          "dpName": "The DP name",
          "dpValueStd": "The current DP value",
          "property": {
            "range": "The value range of the attribute"
          },
          "propertyDetail": {},
          "mode": "The mode such as `ro` and `rw`. This feature is added to v1.4.3",
          "dpFrom": "String"
        }
      ],
      "masterGroupJoinStatus": "Indicates whether the device has joined the main group. Valid values: `0`: no. `1`:yes. `2`: a non-lighting device that has not joined the main group",
      "currentBrightness": "The brightness threshold of the room to which the device belongs",
      "supportGroup": "Check whether the device can be grouped",
      "switchStatus": "The switch status",
      "switchDpCode": "The switch DP code",
      "colourValue": "The color value",
      "brightPercentValue": "The brightness percentage value"
      "pointDeviceType": "The device type on the location map",
      "switchCount": "int",
      "dpFrom": "String",
      "devicePurpose": {
        "ID": "The ID",
        "name": "The name",
        "code": "The code",
      },
      "industryPurpose": {
        "ID": "The ID",
        "name": "The name",
        "code": "The code",
      },
      "x": "The x-axis coordinate of the location",
      "y": "The y-axis coordinate of the location",
      "category": "The second-level category of the product",
      "iconUrl": "The icon of a device",
      "uuID": "The UUID of a device"
    }
  ]
}

Control the group

API description

Control the group through the data points (DPs).

API endpoint

POST /v1.0/illumination/group/package/control

Request parameter

Parameter name	Data type	Parameter type	Description	Required
groupPackageId	String	body	The group ID.	true
dpCode	String	body	The DP code.	true
dpValue	String	body	The DP value.	true

Return parameter

Parameter name	Data type	Description
code	Integer	The error code. For more information, see the error code section. It is empty when the operation succeeded.
success	Boolean	Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.
msg	String	The error message that is returned if the request fails. It is empty if the request is successful.
t	Long	The returned 13-bit timestamp.
result	Object	The returned result.

Description of result parameter

boolean{}

Sample request

{
  "dpValue": "The DP value",
  "dpCode": "The DP code",
  "groupPackageId": "The ID of a group",
}

Sample response

boolean{}

DeviceTypeEnum

deviceTypeValue	deviceType	Description
-1	other	Others
0	intelligent_lamp	Smart light
1	gateway	Gateway
2	no_intelligent_lamp	Non-smart light
3	switch	Switch
4	sensor	Sensor

Error code

The following table describes common error codes for this API. For more information, see Error Code.

Error code	Description
500	A system error has occurred while processing your request.
1106	Illegal permissions.