1. 描述
修改户属信息。本接口是God可以访问的,God几乎可以修改Room的所有属性。在未来,Room的不重要属性可以被其它角色修改。
2. 调用场景
开发者登录超级控制台后,可以修改自己创建的户属。开发者以God角色修改户属。未来可能开放给专门的户属/设备运维。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | Setusra | |
URL | https://api.xdua.com/usra | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神户属,才可以创建户属 |
XduaApiAudience | ConsoleR | 只有usra_id为ConsoleX的户属,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 户属直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Butler | 只要登录就可以创建户属 |
XduaApiResource | usra | |
XduaApiKparam | id | |
XduaApiAction | UpdateRoom | |
XduaApiRule | UpdateRoom | |
XduaApiAstates | 0 | 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | String | 是 | 无 | 6tYu82hM | 户属ID |
type | body | String | 否 | 无 | Mats | 户属类型代码,本字段受usra_type表的code字段外键约束 |
addr | body | String | 否 | 无 | 店铺地址 | |
name | body | String | 否 | 无 | 蓝牙网关 | 店铺名字 |
build_id | body | String | 否 | 无 | 12345678 | 户属所属楼栋的ID |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的户属ID |
updates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的户属名",
"brief":"新的户属介绍",
}
}
6. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
7. SDK调用
为了方便测试SetRoom
接口。数据库专门提供了一个测试户属usra_id=TeStTeSt
。可以对这个户属的所有属性进行修改,而不用担心损坏数据库。
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})
/*----------------------------
* 运行如下代码
* 下面的代码是直接可以运行的
*--------------------------*/
api_name = "修改户属";
const usra_id ="TeStTeSt"; //要修改的户属ID
/*----------------------------
* 下面展示的是修改"TeStTeSt"所有属性的操作,实际上可以只修改其中任何一个到两个参数
*--------------------------*/
const set_params = {
type:"Room", //户属新的类型
name:"测试户属", //名字
addr:"户属新的地址", //户属生产商
}
const res_api = await xduaClient.setRoom(usra_id,set_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash