位置管理接口

创建位置

  • 接口intent:config.position.create
  • 接口描述:本接口用于创建(空间)位置,树状结构,最大可支持10级。

  • 请求参数

名称 类型 是否必须 描述
positionName String 位置名称,可以根据用户自定义
description String 位置描述,可以根据用户自定义
parentPositionId String 父位置id,创建顶级位置时为空
  • 请求示例
{
    "intent": "config.position.create",
    "data": {
        "positionName": "测试房间"
    }
}

返回参数

名称 类型 描述
positionId String 位置id
  • 返回参数
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": {
        "positionId": "real1.836663300479156224"
    }
}

更新位置

  • 接口intent:config.position.update
  • 接口描述:本接口用于修改指定(空间)位置的名称和描述。

  • 请求参数

名称 类型 是否必须 描述
positionId String 位置ID
positionName String 更新的位置名称
description String 更新的位置描述
  • 请求示例
{
    "intent": "config.position.update",
    "data": {
        "positionId": "real1.836663300479156224",
        "positionName": "客厅"
    }
}
  • 返回参数:无
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": ""
}

删除位置

  • 接口intent:config.position.delete
  • 接口描述:本接口用于删除指定(空间)位置,删除的前置条件:当前空间下没有设备、条件集、自动化和场景。

  • 请求参数

名称 类型 是否必须 描述
positionId String 位置
  • 请求示例
{
    "intent": "config.position.delete",
    "data": {
        "positionId": "real1.836663300479156224"
    }
}
  • 返回参数:无
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": ""
}

修改位置时区

  • 接口intent:config.position.timeZone
  • 接口描述:本接口用于设置顶级位置的时区,设置时区后,该位置树下所有设备、自动化和场景的定时和时段功能均随该时区执行。仅Aqara账号授权虚拟账号授权支持该功能。

  • 请求参数

名称 类型 是否必须 描述
positionId String 顶级位置ID
timeZone String 需设置的目标时区,格式示例:GMT+08:00
  • 请求示例
{
    "intent": "config.position.timeZone",
    "data": {
        "positionId":"real1.768799734012641280",
        "timeZone": "GMT+08:00"
    }
}
  • 返回参数:无
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": null,
    "requestId": "",
    "result": ""
}

查询下级位置信息

  • 接口intent:query.position.info
  • 接口描述:本接口用于查询指定位置的下一级位置信息。

  • 请求参数

名称 类型 是否必须 描述
parentPositionId String 父位置ID,为空则查询用户/项目下所有顶级位置id
pageNum int 页码,默认值1,最小值为1
pageSize int 每页item个数,默认值30
  • 请求参数
{
    "intent": "query.position.info",
    "data": {
        "parentPositionId": "real1.768799734012641280",
        "pageNum": 1,
        "pageSize": 5
    }
}
  • 返回参数
名称 类型 描述
parentPositionId String 父位置id
positionId String 位置id
positionName String 位置名称
description String 位置描述
createTime String 创建时间
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": {
        "data": [
            {
                "positionName": "默认房间",
                "positionId": "real2.768799734306242560",
                "createTime": 1603337732360,
                "description": "",
                "parentPositionId": "real1.768799734012641280"
            }
        ],
        "totalCount": 1
    }
}

查询位置详情

  • 接口intent:query.position.detail
  • 接口描述:本接口用于查询指定位置的详细信息,支持批量查询,最大同时支持查询50个位置。

  • 请求参数

名称 类型 是否必须 描述
positionIds Array(String) 位置id数组,最大50
  • 请求参数
{
  "intent": "query.position.detail",
  "data": {
    "positionIds": ["real2.788499435001516032"]
  }
}
  • 返回参数
名称 类型 描述
parentPositionId String 父位置id
positionId String 位置id
positionName String 位置名称
description String 位置描述
createTime String 创建时间
  • 返回示例
{
    "code": 0,
    "requestId": "5687.29.16261618415596403",
    "message": "Success",
    "msgDetails": null,
    "result": [
        {
            "positionName": "默认房间",
            "positionId": "real2.788499435001516032",
            "createTime": 1608034514920,
            "description": "",
            "parentPositionId": "real1.788499434967961600"
        }
    ]
}
Copyright © 2023 深圳绿米联创科技有限公司 all right reserved,powered by Gitbook文档修改时间: 2024-09-27 21:51:47

results matching ""

    No results matching ""