1. 描述

创建楼栋。

2. 调用场景

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

3. 配置参数

参数意义参考接口参数

4. 请求参数

5. 返回参数

6. 错误码

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

7. SDK调用

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

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
const add_params = {
    type:"Test",        //类别
    model:"Motest2",    //型号,Motest这个词取自Model Test合词
    vlot:360,           //本楼栋对应的所有设备的数据在日志表里存6分钟数据
    name:"测试楼栋",    //名字
    man:"xdua.com",     //楼栋生产商,地球号团队制作的硬件的生产商是xuda.com
    pkey:"a1lPKOTest2", //阿里云平台ProductKey,从那里拷贝过来
    brief:"接口测试",   //简介
    cost:45,            //采购或者生产这个硬件的成本
    earn:60,            //对外销售价格
}

let res = await xduaClient.addBuild(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 build_id ="TeStTeSt"; //要删除的楼栋ID
let res = await xduaClient.delBuild(build_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 = "查询楼栋";


/*------------------------------------------------------
 * 分页查询制造商Minew的所有楼栋，显示第2页,每页显示20条
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{man:"Minew"}    
}

/*------------------------------------------------------
 * 分页查询不是制造商Minew的所有楼栋，显示第2页,每页显示20条
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{"man[!]":"Minew"}    
}

/*------------------------------------------------------
 * 分页查询制造商是Minew和xdua.com的所有楼栋，显示第1页,每页显示20条
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:2,
    where:{
        man:["Minew","xdua.com"],
    }    
}

/*------------------------------------------------------
 * 分页查询楼栋名字是`虚拟网关`
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        name:"虚拟网关",
    }    
}

/*------------------------------------------------------
 * 分页查询楼栋名字包含`网关`二字,这是一种模糊查询方式,注意两点
 * 1. 要有`[~]`
 * 2. 字串模糊的地方要有%,`%网关%`表示前后都可能有其它串,`%网关`表示必须以`网关`结尾。
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        "name[~]":"%网关%",
    }    
}



const res_api = await xduaClient.qryBuild(query_params)

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

```

{% sample lang="php" -%}

文档还没有实现

```bash

8. 描述

回收楼栋。

9. 调用场景

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

10. 配置参数

参数意义参考接口参数

11. 请求参数

12. 返回参数

13. 错误码

14. 描述

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

15. 调用场景

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

16. 配置参数

参数意义参考接口参数

17. 请求参数

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 build_id ="TeStTeSt"; //要修改的楼栋ID

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

• 下面展示的是修改"TeStTeSt"所有属性的操作，实际上可以只修改其中任何一个到两个参数 --------------------------/ const set_params = { type:"Test", //类别 model:"Motest3", //型号 vlot:360, //它在日志表里存6分钟数据 name:"测试楼栋", //名字 man:"xdua.com", //楼栋生产商 pkey:"a1lPKOTest2", //阿里云平台ProductKey,从那里拷贝过来 brief:"接口测试", //简介 earn:65, //价格 cost:45, //成本 }

const res_api = await xduaClient.setBuild(build_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                   |SetBuildtmpl                  |         |
|URL                    |https://api.xdua.com/buildtmpl|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |SET                      |         |
|XduaApiColor      |X                        | 只有持有神楼栋，才可以创建楼栋        |
|XduaApiAudience   |ConsoleX                 | 只有build_id为ConsoleX的楼栋，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 楼栋直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject    |i                        | i,只有创建者自己才可以修改|
|XduaApiRoles           |Zoon                     | 只要登录就可以创建楼栋|
|XduaApiResource        |build                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |UpdateBuildtmpl               |     |
|XduaApiRule            |UpdateBuildtmpl               |     |
|XduaApiAstates         |0              | 按序build,zone,corp,shop,build,build,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. 错误码