1. 描述

应用管理主要在超级控制台下进行。开发者进入consolex.xdua.com,点击自己的社区，进入社区(触发AddLogon操作)，创建应用。

2. 接口动作

3. 资源状态

4. 错误码

参考错误码

5. 描述

创建房间。

6. 调用场景

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

创建房间需要用户先登录自己的账户，进入企业，店铺，然后创建。

7. 配置参数

参数意义参考接口参数

8. 请求参数

9. 返回参数

10. 错误码

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

11. SDK调用

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

/*-----------------------------------------------------------
 * 首先在控制台点击企业按钮，进入企业
 *---------------------------------------------------------*/

api_name = "登续到济南分所";
logon_param = {
    id  :   "IctJinan",
}

res = await xduaClient.addLogon(logon_param)
if(res.status == 200){
    if(res.error == 0){
        got_zone_id = res.result.id;
        console.log(api_name+"成功 ");
    }else{
        got_zone_id = res.result.id;
        console.log(res);
    }
}else{
    console.log(res);
}
/*-----------------------------------------------------------
 * 首先在控制台点击店铺按钮，进入店铺
 *---------------------------------------------------------*/
api_name = "登续到商务中心养老院";
logon_param = {
    id  :   "Facility",
}

res = await xduaClient.addLogon(logon_param)
if(res.status == 200){
    if(res.error == 0){
        got_zone_id = res.result.id;
        console.log(api_name+"成功 ");
    }else{
        got_zone_id = res.result.id;
        console.log(res);
    }
}else{
    console.log(res);
}




/*-----------------------------------------------------------
 * 在店铺界面创建房间
 *---------------------------------------------------------*/
const add_params = {
    build_id:"W0wPuXU3",                             //房间所在的楼栋,`商务中心A座`
    type_id:"m5d00001",                             //房间种类ID,表示`养老院护理间`
    name:"一楼107",                                 //房间的名字
    addr:"商务中心养老公寓主楼107",     //房间地址,这个会做全平台唯一性检查
}



let res = await xduaClient.addRoom(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 room_id ="TeStTeSt"; //要删除的房间ID
let res = await xduaClient.delRoom(room_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 = "查询房间";


/*------------------------------------------------------
 * 分页查询店铺(shop_id)下的所有房间,
 * 比方说，某个养老院的所有房间
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{shop_id:"Facility"}    
}

/*------------------------------------------------------
 * 查询房间名字的模糊查询
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{"name[~]":"%济南市%"}    
}

/*------------------------------------------------------
 * 分页查询小区`Vila0001`下的房间
 * 
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        vila_id:"Vila0001",
    }    
}


const res_api = await xduaClient.qryRoom(query_params)

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

```

{% sample lang="php" -%}

文档还没有实现

```bash

12. 描述

回收房间。

13. 调用场景

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

14. 配置参数

参数意义参考接口参数

15. 请求参数

16. 返回参数

17. 错误码

18. 描述

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

19. 调用场景

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

20. 配置参数

参数意义参考接口参数

21. 请求参数

22. 返回参数

示例

result字段

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

23. 错误码

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

24. SDK调用

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

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

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

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

• 下面展示的是修改"TeStTeSt"所有属性的操作，实际上可以只修改其中任何一个到两个参数 --------------------------/ const set_params = { type:"Room", //房间新的类型 name:"测试房间", //名字 addr:"房间新的地址", //房间生产商 }

const res_api = await xduaClient.setRoom(room_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                   |SetRoomtmpl                  |         |
|URL                    |https://api.xdua.com/roomtmpl|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |SET                      |         |
|XduaApiColor      |X                        | 只有持有神房间，才可以创建房间        |
|XduaApiAudience   |ConsoleX                 | 只有room_id为ConsoleX的房间，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 房间直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject    |i                        | i,只有创建者自己才可以修改|
|XduaApiRoles           |Zoon                     | 只要登录就可以创建房间|
|XduaApiResource        |room                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |UpdateRoomtmpl               |     |
|XduaApiRule            |UpdateRoomtmpl               |     |
|XduaApiAstates         |0              | 按序room,zone,corp,shop,room,room,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":"新的房间介绍",    
    }    
}

25. 错误码