1. 描述

创建房人。房人是房间和用户的关系。把用户和房间关联起来。房间和用户之间是一对多关系。

2. 调用场景

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

3. 配置参数

参数意义参考接口参数

4. 请求参数

[!note|label:为什么使用授角ID而不是用户ID?] 用户一定是以某个角色进入房间的：老人，护工，管家？

5. 返回参数

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

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

/*----------------------------
 * 运行如下代码
 * 下面的删除操作是不会成功的，
 * 因为"TeStTeSt"作为一个测试房人是不可以被删除的。如果为了测试，可以新建一个房人，然后立刻删除。
 *--------------------------*/
const rosr_id ="TeStTeSt"; //要删除的房人ID
let res = await xduaClient.delRosr(rosr_id)
if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

```

{% sample lang="php" -%}

文档还没有实现

```bash

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

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
api_name = "查询房人";


/*---------------------------------------
 * 查询room_id=="9COkOKGl"下的所有人员
 * 下面的代码是直接可以运行的
 *-------------------------------------*/

let query_param = {
    limit:20,
    page:1,
    where:{room_id  :   "9COkOKGl"}    
}

/*---------------------------------------
 * 查询room_id=="9COkOKGl"下的所有护工
 * 下面的代码是直接可以运行的
 *-------------------------------------*/

let query_param = {
    limit:20,
    page:1,
    where:{room_id  :   "9COkOKGl",role_code:"Carer"}    
}


const res_api = await xduaClient.qryRosr(query_params)

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

```

{% sample lang="php" -%}

文档还没有实现

```bash

8. 描述

回收房人。

9. 调用场景

管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的房人。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的房人的名字。

10. 配置参数

参数意义参考接口参数

11. 请求参数

12. 返回参数

13. 错误码

14. 描述

修改房人信息。本接口是Butler可以访问的，Butler几乎可以修改Rosr的所有属性。在未来，Rosr的不重要属性可以被其它角色修改。

15. 调用场景

开发者登录超级控制台后,可以修改自己创建的房人。开发者以God角色修改房人。未来可能开放给专门的房人/设备运维。

16. 配置参数

参数意义参考接口参数

17. 请求参数

[!note|label:为什么修改操作只能修改type和name?] 因为rosr本身就是两个元素room和usro的搭配，修改任何一个的效果等同于删除重建。

18. 返回参数

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的房人名",
        "brief":"新的房人介绍",    
    }    
}

19. 错误码

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

20. SDK调用

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

/*----------------------------

• 运行如下代码
• 下面的代码是直接可以运行的 --------------------------/ api_name = "修改房人"; const rosr_id ="TeStTeSt"; //要修改的房人ID

/*----------------------------

• 下面展示的是修改"TeStTeSt"所有属性的操作，实际上可以只修改其中任何一个到两个参数 --------------------------/ const set_params = { type:"Test", //类别 name:"测试房人", //名字 }

const res_api = await xduaClient.setRosr(rosr_id,set_params)

if(res.error == 0){ console.log("测试成功");
}else{ console.log("测试失败");
console.log(res); } </code></pre> </div>

```

{% sample lang="php" -%}

文档还没有实现

</code></pre>
</div></div></div>
# 描述

修改房人。

# 调用场景

开发者登录[超级控制台](http://consolex.xdua.com)后,可以修改自己创建的房人。修改仅仅限于可以修改的name,brief等字段。


# 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|Name                   |SetRosrtmpl                  |         |
|URL                    |https://api.xdua.com/rosrtmpl|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |SET                      |         |
|XduaApiColor      |X                        | 只有持有神房人，才可以创建房人        |
|XduaApiAudience   |ConsoleX                 | 只有rosr_id为ConsoleX的房人，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject    |i                        | i,只有创建者自己才可以修改|
|XduaApiRoles           |Zoon                     | 只要登录就可以创建房人|
|XduaApiResource        |rosr                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |UpdateRosrtmpl               |     |
|XduaApiRule            |UpdateRosrtmpl               |     |
|XduaApiAstates         |0              | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED)    |
|XduaApiEnable          |true                     | 接口使能    |


# 请求参数

|名称       | 位置|类型     |必填    |默认值  |示例    |说明                |
|-------    |-----|---------|--------|--------|--------|------------        |
|id         |path |string   |是      |        |rYub4wrT|要修改的房人ID      |
|name       |body |string   |否      |        |        |房人的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符 |
|avatar     |body |string   |否      |        |        |房人图标，不超过40个字符。|
|brief      |body |string   |否      |        |        |房人描述，不超过64个字符。|

|名称       | 位置|类型     |必填    |默认值    |示例                       |说明                       |
|-------    |-----|---------|--------|--------  |--------                   |------------               |
|user_id|path|String|用户m5d,登陆时获得|可选|
|oldpwd |body|String|旧房人,32位md5码|可选|
|pwd    |body|String|新房人,32位md5码|可选|



# 返回参数

|名称       | 位置  |类型       |示例        |说明                         |
|-------    |-----  |-----------|------------|------------                 |
|id         |result |string     |rYub4wrT    |修改的房人ID                 |
|ipdates    |result |json dict  |            |修改的内容                   |


#### 示例

result字段

```json
{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的房人名",
        "brief":"新的房人介绍",    
    }    
}

21. 错误码