Get Status Set

Last Updated on : 2024-09-10 01:49:18

Get the status set based on the standard category.

API address

GET: /v1.0/iot-03/categories/{category}/status

Request parameter

Parameter nameTypeINRequiredDescription
categoryStringuritrueThe product category.

Return parameter

Parameter nameTypeDescription
resultStatusResThe returned result.

Description of result

Parameter nameTypeDescription
categoryStringThe product category.
status_listListThe status set.

Description of status_list

Parameter nameTypeDescription
nameStringThe name of status.
codeStringThe code of status.
typeStringThe type.
valuesStringThe input parameter range.

Request example

GET: /v1.0/iot-03/categories/kg/status

Return example

{
    "result": {
        "statusList": [
            {
                "code": "relay_status",
                "values": "{\"range\":[\"off\",\"on\",\"memory\"]}",
                "type": "Enum",
                "name": "Power status setting"
            }
        ],
        "category": "tgkg"
    },
    "t": 1571293457435,
    "success": "true"
}

Error code

For more information, see error code.