1. 描述

创建房物。

2. 调用场景

店长登录超级控制台后,可以以Shep角色创建自己的房物。房物创建目前只能由Butler进行。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddRood
Url https://api.xdua.com/rood
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神房物，才可以创建房物
XduaApiAudience ConsoleR 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 房物直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 需要登录
XduaApiRole Butler 目前地球号只允许God添加房物,未来这个功能会让给一个专门维护房物和设备录入的角色。
XduaApiResource rood
XduaApiKparam pkey 在阿里云物联网平台创建的房物的ProductKey
XduaApiAction CreateRood
XduaApiRule CreateRood
XduaApiAstates 0 所有的资源都要确认state是0
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
type body String 是 无 Mats 房物类型代码,本字段受rood_type表的code字段外键约束
name body String 是 无 Mats 房物名称
room_id body String 是 无 Minew 房间的ID
dev_id body String 是 无 Minew 设备的ID

5. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的房物ID

6. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

7. SDK调用




const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/

api_name = "创建房物";
add_rood_param={
    room_id : "TeStTeSt",        //房间ID,`TeStTeSt`是个测试房间号
    type    : "Room",            //类别
    name    : "放在卧室里的床带", //名字，不是设备的名字，而是这个设备放在这个房间，起个名字
    dev_id  : "n7obGqL3", //设备ID,这个ID必须从设备表获取
}


let res = await xduaClient.addRood(add_params)
if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

results matching ""

    No results matching ""