Get Status Set

Last Updated on : 2023-06-15 05:03:50

Get the standard status set of the device group by group ID.

API address

GET: /v1.0/iot-03/device-groups/{group_id}/status-set

Request parameter

Parameter name	Type	IN	Required	Description
group_id	String	uri	true	The ID of a specified group.

Return parameter

Parameter name	Type	Description
result	GroupStatusRes	The returned result.

Description of result

Parameter name	Type	Description
group_id	String	The ID of a device group.
status	List	The status set of a device group.

Description of status

Parameter name	Type	Description
name	String	The name of status.
desc	String	The description of status.
code	String	The code of status.
type	String	The type of status.
values	String	The value of status.

Request example

GET: /v1.0/iot-03/device-groups/12kljskerexxxxd23w/status-set

Return example

{
    "result": {
        "group_id": "1425638346989768773",
        "status": [
            {
                "code": "report_period_set",
                "values": "{\"range\":[\"1h\",\"2h\",\"3h\",\"4h\",\"6h\",\"8h\",\"12h\",\"24h\",\"48h\",\"72h\"]}",
                "type": "Enum",
                "name": "report period set"
            },
            {
                "code": "prepayment_switch",
                "values": "{}",
                "type": "Boolean",
                "name": "prepayment switch"
            },
            {
                "code": "auto_clean",
                "values": "{}",
                "type": "Boolean",
                "name": "auto clean"
            },
            {
                "code": "charge_money",
                "values": "{\"unit\":\"¥\",\"min\":0,\"max\":999999,\"scale\":2,\"step\":1}",
                "type": "Integer",
                "name": "charge money"
            },
            {
                "code": "balance",
                "values": "{\"unit\":\"¥\",\"min\":0,\"max\":999999,\"scale\":2,\"step\":1}",
                "type": "Integer",
                "name": "balance"
            },
            {
                "code": "temp_current",
                "values": "{\"unit\":\"℃\",\"min\":-100,\"max\":100,\"scale\":0,\"step\":1}",
                "type": "Integer",
                "name": "temp current"
            },
            {
                "code": "gas_use_data",
                "values": "{\"unit\":\"m3\",\"min\":0,\"max\":99999999,\"scale\":3,\"step\":1}",
                "type": "Integer",
                "name": "gas use data"
            },
            {
                "code": "cold_switch",
                "values": "{}",
                "type": "Boolean",
                "name": "cold switch"
            }
        ]
    },
    "t": 1629354647528,
    "success": true
}

Error code

For more information, see error code.

Prev DocDevices Group Control

Next DocGet Instruction Set of Device Group