1. 描述
创建房间。
2. 调用场景
开发者登录超级控制台后,可以以Butler角色创建自己的房间。房间创建目前只能由Butler进行。
创建房间需要用户先登录自己的账户,进入企业,店铺,然后创建。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddRoom | |
Url | https://api.xdua.com/room | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | R | 只有持有神房间,才可以创建房间 |
XduaApiAudience | ConsoleR | 只有room_id为ConsoleX的房间,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 房间直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRole | God | 目前地球号只允许God添加房间,未来这个功能会让给一个专门维护房间和设备录入的角色。 |
XduaApiResource | room | |
XduaApiKparam | pkey | 在阿里云物联网平台创建的房间的ProductKey |
XduaApiAction | CreateRoom | |
XduaApiRule | CreateRoom | |
XduaApiAstates | 0 | 所有的资源都要确认state是0 |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
type_id | body | String | 是 | 无 | 房间的种类 | 房间类型ID,本字段受room_type表的id字段外键约束 |
build_id | body | String | 是 | 无 | 建筑的ID | 房间所在的楼栋,如果不知道就填UnknownB |
name | body | String | 是 | 无 | 房间的名字 | 房间的名字,可以随意设置 |
addr | body | String | 是 | 无 | 房间的地址 | 房间的地址,是唯一设置的。它和shop_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...",//开发者在地球号开发者网站创建的登录令牌
})
/*-----------------------------------------------------------
* 首先在控制台点击企业按钮,进入企业
*---------------------------------------------------------*/
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