1. 创建户串

1.1. 描述

创建户串。

1.2. 调用场景

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

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

1.3. 配置参数

参数意义参考接口参数

1.4. 请求参数

[!NOTE|label:当微信扫码绑定时] 当用微信扫码绑定的时候, ustr字段放的是微信扫码SDK生成的code字段，样子如下http://api.svkernel.xdua.com/ustr?type=V&ustr=071iJVFa1t6kUz0ADeJa13Knog1iJVFt

1.5. 返回参数

这些参数是直接从腾讯的接口里获取的，字段也没有改变,保持与腾讯一致。

{
    head_img: "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIYhTiblmCXm2ekuyvlSkROJ3gMWNZPvw5RXf6Eh97ibBLexRAQQM7hh7uGQ1w9a7PMmJ9mibfT79Hdg/132",
    nickname: "焦帅",
    openid: "oA9KU5q5B5163ozPzw1C_GFd7ULc",
    unionid: "o6EyZv2HuY8STp3hLBV9TFOqs84U",
}

1.6. 错误码

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

1.7. SDK调用

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

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

api_name = "登续到济南分所";
add_param = {
    type  :   "V",
    ustr  :  "071iJVFa1t6kUz0ADeJa13Knog1iJVFt",
}

res = await xduaClient.addUstr(add_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);
}

```

{% sample lang="php" -%}

文档还没有实现

```bash

2. 删除户串

2.1. 描述

删除户串。

2.2. 调用场景

God在超级控制台登录. 它会让资源永久消失。但要删除一个户串，你需要把户串对应的所有设备都删除，才能删除户串。

2.3. 配置参数

参数意义参考接口参数

2.4. 请求参数

2.5. 返回参数

2.6. 错误码

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

2.7. SDK调用

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

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

```

{% sample lang="php" -%}

文档还没有实现

```bash

3. 关闭户串

3.1. 描述

关闭户串。

3.2. 调用场景

神管理员登录超级控制台后,可以关闭普通开发者的户串。使得户串进入DISABLED状态，也只有Zoon角色重新打开这个户串。

管理员（Zoon）

1. 登录http://consoler.{zond_id}.xdua.com后,
2. 根据条件查询户串，条件是某个户串。
3. 点击冻结，可以关闭户串。

3.3. 配置参数

参数意义参考接口参数

3.4. 请求参数

3.5. 返回参数

3.6. 错误码

4. 软删户串

4.1. 描述

软删户串。

4.2. 调用场景

开发者登录超级控制台后,可以点击自己的户串，然后删除掉。如果哪天后悔了，可以联系Zoon来恢复。

4.3. 配置参数

参数意义参考接口参数

4.4. 请求参数

4.5. 返回参数

4.6. 错误码

5. 打开户串

5.1. 描述

打开户串。

5.2. 调用场景

管理员（Zoon）

1. 登录http://consolex.xdua.com后,
2. 根据条件查询户串，条件是某个被冻结的户串。
3. 点击解冻，可以解冻店铺。

5.3. 配置参数

参数意义参考接口参数

5.4. 请求参数

5.5. 返回参数

5.6. 错误码

6. 详情户串

6.1. 描述

详情户串。

6.2. 调用场景

管理员登录超级控制台后,可以随意查询能看见的所有户串列表。点击其中一个户串（不管是不是自己的），就可以点击访问。

6.3. 配置参数

6.4. 请求参数

6.5. 返回参数

[!note] 户串的使能状态,0:打开 1:关闭. 关闭的户串处于冻结状态,不接受登陆/注册所有操作.

返回示例

result部分

{
    "id":"rYub4wrT",
    "data": {


    },
}

6.6. 错误码

7. 私详户串

7.1. 描述

私详户串。

7.2. 调用场景

开发者登录超级控制台后,在户串列表，选择户串，点击详情，就可以查看自己的户串。GIT的默认字段和GET不一样。

7.3. 配置参数

7.4. 请求参数

7.5. 返回参数

返回示例

result部分

{
    "id":"rYub4wrT",
    "data": {


    },
}

7.6. 错误码

8. 下线户串

8.1. 描述

下线户串。

8.2. 调用场景

开发者登录超级控制台后,可以下线自己创建的户串。

8.3. 配置参数

参数意义参考接口参数

8.4. 请求参数

8.5. 返回参数

8.6. 错误码

9. 发布户串

9.1. 描述

发布户串。

9.2. 调用场景

开发者登录超级控制台后,可以下线/发布自己的户串。这个动作是管理员不能干涉的。

9.3. 配置参数

参数意义参考接口参数

9.4. 请求参数

9.5. 返回参数

9.6. 错误码

10. 私查户串

10.1. 描述

私查户串。

10.2. 调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有户串。

10.3. 配置参数

参数意义参考接口参数

10.4. URL

GET:https://api.xdua.com/ustrtmpl

10.5. 请求参数

参考标准查询接口请求参数

10.6. 返回参数

参考标准查询接口返回参数

result.list部分

10.7. 错误码

11. 查询户串

11.1. 描述

查询户串。

11.2. 调用场景

开发者登录http://consolex.xdua.com后,可以以God角色查询属于所有户串。

11.3. 配置参数

参数意义参考接口参数

11.4. URL

GET:https://api.xdua.com/ustr

11.5. 请求参数

参考标准查询接口请求参数

11.6. 返回参数

参考标准查询接口返回参数

result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。

11.7. 错误码

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

11.8. SDK调用

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

11.9. 描述

回收户串。

11.10. 调用场景

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

11.11. 配置参数

参数意义参考接口参数

11.12. 请求参数

11.13. 返回参数

11.14. 错误码

12. 修改户串

12.1. 描述

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

12.2. 调用场景

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

12.3. 配置参数

参数意义参考接口参数

12.4. 请求参数

12.5. 返回参数

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的户串名",
        "brief":"新的户串介绍",    
    }    
}

12.6. 错误码

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

12.7. SDK调用

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

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

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

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

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

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

12.8. 错误码