1. 描述
删除套房。
2. 调用场景
God在超级控制台登录. 它会让资源永久消失。但要删除一个套房，你需要把套房对应的所有设备都删除，才能删除套房。
3. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | DelHome | |
| URL | https://api.xdua.com/home | |
| Method | DELETE | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | DEL | |
| XduaApiColor | X | 只有持有神套房，才可以创建套房 |
| XduaApiAudience | ConsoleX | 只有home_id为ConsoleX的套房，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 套房直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
| XduaApiRoles | God | Zoon可以删除套房 |
| XduaApiResource | home | |
| XduaApiKparam | id | |
| XduaApiAction | DeleteHome | |
| XduaApiRule | DeleteHome | |
| XduaApiAstates | 0 | 所有state检查 |
| XduaApiEnable | true | 接口使能 |
4. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要删除的套房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...",//开发者在地球号开发者网站创建的登录令牌
})
/*----------------------------
* 运行如下代码
* 下面的删除操作是不会成功的，
* 因为"TeStTeSt"作为一个测试套房是不可以被删除的。如果为了测试，可以新建一个套房，然后立刻删除。
*--------------------------*/
const home_id ="TeStTeSt"; //要删除的套房ID
let res = await xduaClient.delHome(home_id)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash