1. 描述
创建房人。房人是房间和用户的关系。把用户和房间关联起来。房间和用户之间是一对多关系。
2. 调用场景
店长登录超级控制台后,可以以Butler角色创建自己的房人。房人创建目前只能由Butler进行。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddRosr | |
Url | https://api.xdua.com/rosr | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神房人,才可以创建房人 |
XduaApiAudience | ConsoleR | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRole | Butler | 目前地球号只允许God添加房人,未来这个功能会让给一个专门维护房人和设备录入的角色。 |
XduaApiResource | rosr | |
XduaApiKparam | pkey | 在阿里云物联网平台创建的房人的ProductKey |
XduaApiAction | CreateRosr | |
XduaApiRule | CreateRosr | |
XduaApiAstates | 0 | 所有的资源都要确认state是0 |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
type_id | body | String | 是 | 无 | Mats | 房人类型ID,本字段受rosr_type表的id字段外键约束 |
name | body | String | 是 | 无 | Mats | 房人名称 |
room_id | body | String | 是 | 无 | Minew | 房间的ID |
usro_id | body | String | 是 | 无 | 12345678 | 授角的ID |
[!note|label:为什么使用授角ID而不是用户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_rosr_param={
room_id : "TeStTeSt", //房间ID,`TeStTeSt`是个测试房间号
type : "Room", //类别
name : "803房间4号床位刘梅", //这是一个典型的机构养老场景,
usro_id : "n7obGqL3", //用户的授角ID
}
let res = await xduaClient.addRosr(add_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash