1. 目录
一个房间(也可以是家庭下的虚拟房间)里可以绑定多个用户
缩名 |
全名 |
方法 |
中文 |
角色 |
描述 |
ADD |
Create |
POST |
创建 |
Zoon |
创建店铺 |
DEL |
Delete |
DELETE |
删除 |
Funder |
删除店铺 |
SET |
Update |
PUT |
修改 |
Zoon |
修改店铺 |
DOL |
Deleto |
PUT |
软删 |
Zoon |
软删店铺 |
DIS |
Disable |
PUT |
关闭 |
Ceo |
关闭店铺 |
ENB |
Enable |
PUT |
打开 |
Ceo |
打开店铺 |
RCC |
Recycle |
PUT |
回收 |
Ceo |
回收店铺 |
PUB |
Publish |
PUT |
发布 |
Zoon |
发布店铺 |
OFF |
Offline |
PUT |
下线 |
Zoon |
下线店铺 |
GET |
Get |
GET |
详情 |
Ceo |
详情店铺 |
GIT |
Git |
GET |
私详 |
Zoon |
私详店铺 |
QRY |
Query |
GET |
查询 |
Ceo |
查询店铺 |
QRI |
Queri |
GET |
私查 |
Zoon |
私查店铺 |
2. 创建房人。房人是房间和用户的关系。把用户和房间关联起来。房间和用户之间是一对多关系。
调用场景
店长登录超级控制台后,可以以Butler角色创建自己的房人。房人创建目前只能由Butler进行。
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
type_id |
body |
String |
是 |
无 |
Mats |
房人类型ID,本字段受rosr_type表的id字段外键约束 |
name |
body |
String |
是 |
无 |
Mats |
房人名称 |
room_id |
body |
String |
是 |
无 |
Minew |
房间的ID |
usro_id |
body |
String |
是 |
无 |
12345678 |
授角的ID |
[!note|label:为什么使用授角ID而不是用户ID?]
用户一定是以某个角色进入房间的:老人,护工,管家?
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
创建的房人ID |
错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
调用方式
3. 删除房人。
只有房间的管理员才有权限把人从房间踢出去。
调用场景
God在超级控制台登录. 它会让资源永久消失。但要删除一个房人,你需要把房人对应的所有设备都删除,才能删除房人。
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的房人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的房人ID |
4. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
5. SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",
})
const rosr_id ="TeStTeSt";
let res = await xduaClient.delRosr(rosr_id)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash
# 描述
关闭房人。
#### 调用场景
神管理员登录[超级控制台](http://consolex.xdua.com)后,可以关闭普通开发者的房人。使得房人进入DISABLED状态,也只有Zoon角色重新打开这个房人。
管理员(Zoon)
1. 登录[http://consoler.{zond_id}.xdua.com](http://consoler.xdua.com)后,
2. 根据条件查询房人,条件是某个房人。
3. 点击`冻结`,可以关闭房人。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |DisRosrtmpl | |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |DIS | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖房人,只有这个房人的登录人员才可以访问|
|XduaApiSubject |i | 必须是创建者才可以自闭房人|
|XduaApiRoles |Admin | 只有神级管理员才可以关闭普通开发者的房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |DisableRosrtmpl | |
|XduaApiRule |DisableRosrtmpl | |
|XduaApiAstates |`0,0` 或者`0` | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房人ID |
# 错误码
# 描述
软删房人。
#### 调用场景
开发者登录[超级控制台](http://consolex.xdua.com)后,可以点击自己的房人,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |DolRosrtmpl | |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |DOL | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | 只有创建者自己才能删除自己创建的房人|
|XduaApiRoles |Zoon | 只要登录就可以创建房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |DeletoRosrtmpl | |
|XduaApiRule |DeletoRosrtmpl | |
|XduaApiAstates |0 | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房人ID |
# 错误码
# 描述
打开房人。
#### 调用场景
管理员(Zoon)
1. 登录[http://consolex.xdua.com](http://consoler.xdua.com)后,
2. 根据条件查询房人,条件是某个被冻结的房人。
3. 点击`解冻`,可以解冻店铺。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |EnbRosrtmpl | |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |ENB | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |u | 神登录后解冻开发者的房人|
|XduaApiRoles |Admin | 只有神才可以解冻房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |EnableRosrtmpl | |
|XduaApiRule |EnableRosrtmpl | |
|XduaApiAstates |0 | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房人ID |
# 错误码
# 描述
详情房人。
#### 调用场景
管理员登录[超级控制台](http://consolex.xdua.com)后,可以随意查询能看见的所有房人列表。点击其中一个房人(不管是不是自己的),就可以点击访问。
# 配置参数
|参数名 |参数值 |说明 |
|------ |------ |---- |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |GET | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |GET | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | !表示除了允许匿名房人之外的所有房人访问|
|XduaApiRoles |Zoon | 只要Zoon才可以访问其它房人的房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |GetRosrtmpl | |
|XduaApiRule |GetRosrtmpl | |
|XduaApiRosrtmplAstate |0 | 房人zone.state必须是0(STATE_ENABLED) |
|XduaApiCorpAstate |0 | 房人corp.state必须是0(STATE_ENABLED) |
|XduaApiShopAstate |0 | 房人shop.state必须是0(STATE_ENABLED) |
|XduaApiRosrtmplAstate |0 | 房人rosr.state必须是0(STATE_ENABLED) |
|XduaApiRosrtmplAstate |0 | 房人 rosr.state必须是0(STATE_ENABLED) |
|XduaApiRosrtmplAstate |0 | 房人rosr.state必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要修改的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------ |------------ |
|id |result |string |rYub4wrT |详情的角权ID |
|name |result.data |string | |角权的名称 |
|code |result.data |string | |角权的执照号 |
|type |result.data |string | |角权的种类 |
|avatar |result.data |string | |角权图标 |
|brief |result.data |string | |角权的描述 |
|state |result.data |int |1 |角权的状态 |
|stato |result.data |string |"冻服更新" |角权的状态说明 |
|expire |result.data |int |0 |角权状态过期时间(UNIX时间戳) |
|creator_id |result.list[] |string |Dmtv7TrE |社区创建者ID |
|creator_name |result.list[] |string |辣椒帅 |社区创建者名字 |
|ipdator_id |result.list[] |string |XiyRvUp3 |社区最近一次更新者ID |
|ipdator_name |result.list[] |string |周海潮 |社区最近一次更新者名字 |
|cstamp |result.data |string |2020-01-20 02:19:55 |角权创建时间 |
|istamp |result.data |string |2020-01-20 02:23:24 |角权最近更新时间 |
|字段名 |字段类型 | 字段说明 |
|:-------|-------- |--------- |
|id |string |角权的id |
|rosr_id |string |所属户群的id |
|rosr_name |string |所属户群的名字 |
|igrp_id |string |所属户群的id |
|igrp_name |string |所属户群的名字 |
|code |string |角权的代号 |
|name |string |角权名 |
|brief |string |角权说明 |
|avatar |string |角权的头像 |
|enabeld |int |角权的使能状态 |
|cstamp |string |创建的时间戳字符串 |
|istamp |string |更新的时间戳字符串 |
|字段名 |字段类型 | 字段说明 |
|:-------|-------- |--------- |
|id |string |角权的id |
|roue_id |string |所属户群的id |
|roue_name |string |所属户群的名字 |
|igrp_id |string |所属户群的id |
|igrp_name |string |所属户群的名字 |
|code |string |角权的代号 |
|name |string |角权名 |
|brief |string |角权说明 |
|avatar |string |角权的头像 |
|enabeld |int |角权的使能状态 |
|cstamp |string |创建的时间戳字符串 |
|istamp |string |更新的时间戳字符串 |
|字段名 |字段类型 | 字段说明 |
|:-------|-------- |--------- |
|verified|int |1=房人是有效的|
|did |string |请求该房人的设备id|
|uid |string |房人吃鱼者房人id。匿名房人的房人永远是anonymus|
|did |string |请求该房人的设备id|
|aid |string |请求该房人的设备id|
|aud |string |请求该房人的应用的名字,本字段与aid对应|
|nbf |int |Not Before房人生效时间之前|
|iss |string |房人签发机关。在地球号服务中本字段为常值lovearth|
|iat |string |房人签发UTC时间戳|
|ip |string |房人请求时客户端的ip|
|ua |string |房人请求时客户端的RosrtmplAgent|
|exp |int |房人的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的utc时间。| |vtl |int |房人的剩余有效期 validtimelong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的rosr计算vtl为0时,会自动被重置为-1| |ugrp |string |房人持有房人所在的房人群,匿名房人的户群是常量:"xduaxdua"| |role |房人持有房人所在的角色列表,匿名房人的角色列表是常量:"none"| |名称 | 位置 |类型 |示例 |说明 |------- |----- |-----------|------------ |------------ |id |result |ryub4wrt |详情的房人id |name |result.data |房人的名称 |code |房人的执照号 |type |房人的种类 |avatar |房人图标 |brief |房人的描述 |state |1 |房人的状态 |stato |"冻服更新" |房人的状态说明 |expire |0 |房人状态过期时间(unix时间戳) |creator_id |result.list[] |dmtv7tre |社区创建者id |creator_name |辣椒帅 |社区创建者名字 |updator_id |xiyrvup3 |社区最近一次更新者id |updator_name |周海潮 |社区最近一次更新者名字 |cstamp |2020-01-20 02:19:55 |房人创建时间 |ustamp 02:23:24 |房人最近更新时间> [!note]
> 房人的使能状态,0:打开 1:关闭. 关闭的房人处于冻结状态,不接受登陆/注册所有操作.
#### 返回示例
result部分
```json
{
"id":"rYub4wrT",
"data": {
},
}
```
# 错误码
# 描述
私详房人。
#### 调用场景
开发者登录[超级控制台](http://consolex.xdua.com)后,在房人列表,选择房人,点击详情,就可以查看自己的房人。GIT的默认字段和GET不一样。
# 配置参数
|参数名 |参数值 |说明 |
|------ |------ |---- |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |GET | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |GIT | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | 只有自己才可以访问自己创建的房人|
|XduaApiRoles |Zoon | 只要登录就可以创建房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |GetRosrtmpl | |
|XduaApiRule |GetRosrtmpl | |
|XduaApiRosrtmplAstate |0 | 房人zone.state必须是0(STATE_ENABLED) |
|XduaApiCorpAstate |0 | 房人corp.state必须是0(STATE_ENABLED) |
|XduaApiShopAstate |0 | 房人shop.state必须是0(STATE_ENABLED) |
|XduaApiRosrtmplAstate |0 | 房人rosr.state必须是0(STATE_ENABLED) |
|XduaApiRosrtmplAstate |0 | 房人 rosr.state必须是0(STATE_ENABLED) |
|XduaApiRosrtmplAstate |0 | 房人rosr.state必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要修改的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------ |------------ |
|id |result |string |rYub4wrT |详情的房人ID |
|name |result.data |string | |房人的名称 |
|avatar |result.data |string | |房人图标 |
|brief |result.data |string | |房人的描述 |
|state |result.data |int |1 |房人的状态 |
|stato |result.data |string |"冻服更新" |房人的状态说明 |
|expire |result.data |int |0 |房人状态过期时间(UNIX时间戳) |
|creator_id |result.list[] |string |Dmtv7TrE |房人创建者ID |
|creator_name |result.list[] |string |辣椒帅 |房人创建者名字 |
|ipdator_id |result.list[] |string |XiyRvUp3 |房人最近一次更新者ID |
|ipdator_name |result.list[] |string |周海潮 |房人最近一次更新者名字 |
|cstamp |result.data |string |2020-01-20 02:19:55 |房人创建时间 |
|istamp |result.data |string |2020-01-20 02:23:24 |房人最近更新时间 |
#### 返回示例
result部分
```json
{
"id":"rYub4wrT",
"data": {
},
}
```
# 错误码
# 描述
下线房人。
#### 调用场景
开发者登录[超级控制台](http://consolex.xdua.com)后,可以下线自己创建的房人。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |OffRosrtmpl | |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |OFF | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | 只能房人的创建者才能下线自己的房人|
|XduaApiRoles |Zoon | 只要登录就可以创建房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |OfflineRosrtmpl | |
|XduaApiRule |OfflineRosrtmpl | |
|XduaApiAstates |0 | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房人ID |
# 错误码
# 描述
发布房人。
#### 调用场景
开发者登录[超级控制台](http://consolex.xdua.com)后,可以下线/发布自己的房人。这个动作是管理员不能干涉的。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |PubRosrtmpl | |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |PUB | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | 只有房人的创建者自己才能上下线自己的房人|
|XduaApiRoles |Zoon | 只要登录就可以创建房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |OnlineRosrtmpl | |
|XduaApiRule |OnlineRosrtmpl | |
|XduaApiAstates |0 | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房人ID |
# 错误码
# 描述
私查房人。
#### 调用场景
开发者登录[http://consolex.xdua.com](http://consolex.xdua.com)后,可以以Zoon角色查询所有房人。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |QriRosrtmpl | |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |GET | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |QRI | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | 所有注册房人均可以使用|
|XduaApiRoles |Zoon | 必须是Zoon才可以查询角色|
|XduaApiResource |rosr | |
|XduaApiKparam |`where` |常量 |
|XduaApiAction |QueriRosrtmpl | |
|XduaApiRule |QueriRosrtmpl | |
|XduaApiAstates |0 | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
# URL
GET:https://api.xdua.com/rosrtmpl
#### 请求参数
参考[标准查询接口请求参数](http://docapi.xdua.com/api/param_query.html)
#### 返回参数
参考[标准查询接口返回参数](http://docapi.xdua.com/api/param_query.html)
result.list部分
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------ |------------ |
|id |result |string |rYub4wrT |详情的房人ID |
|name |result.list[] |string | |房人的名称 |
|avatar |result.list[] |string | |房人图标 |
|brief |result.list[] |string | |房人的描述 |
|state |result.list[] |int |0 |房人的状态 |
|stato |result.list[] |string |"冻服更新" |房人的状态说 |
|expire |result.list[] |int |0 |房人状态过期时间(UNIX时间戳) |
|creator_id |result.list[] |string |Dmtv7TrE |房人创建者ID |
|creator_name |result.list[] |string |辣椒帅 |房人创建者名字 |
|ipdator_id |result.list[] |string |XiyRvUp3 |房人最近一次更新者ID |
|ipdator_name |result.list[] |string |周海潮 |房人最近一次更新者名字 |
|cstamp |result.list[] |string |2020-01-20 02:19:55 |房人创建时间 |
|istamp |result.list[] |string |2020-01-20 02:23:24 |房人最近更新时间 |
# 错误码
# 查询房人。
GET:https://api.xdua.com/rood
#### 请求参数
参考[标准查询接口请求参数](http://docapi.xdua.com/api/param_query.html)
查询房间"9COkOKGl"里绑定的人类
```
data: {
limit: '10', //每次查询返回的行数
page: '0', //第几页
sort: 'inc:DESC', //按时间倒叙
where: '{"room_id" : "9COkOKGl"}'//查询房间id是"9COkOKGl"的房间里的设备
}
```
查询家庭"15rTsVWR"里人员名单
```
data: {
limit: '10', //每次查询返回的行数
page: '0', //第几页
sort: 'inc:DESC', //按时间倒叙
where: '{"home_id" : "15rTsVWR"}'//查询家庭"9COkOKGl"里的所有设备
}
```
#### 返回参数
参考[标准查询接口返回参数](http://docapi.xdua.com/api/param_query.html)
result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------ |------------ |
|id |body.list[] |string |rYub4wrT |家庭ID |
|type |body.list[] |number | 0 |本字段暂时无意义,未来用 |
|room_id |body.list[] |string | `"P4lTCMkE"` |房间id,如果没有房间,这个字段可以忽略 |
|room_name |body.list[] |string | `高档房间201室` |房间名字,如果没有房间设计,这个字段可以忽略。 |
|home_id |body.list[] |string | `"15rTsVWR"` |房间id,如果没有房间,这个字段可以忽略 |
|home_name |body.list[] |string | `济南分所养老院` |或者是“焦帅的家”这样的 |
|note |body.list[] |string | `测试案例` |备注 |
|user_id |body.list[] |string | `dQ9js7is` |用户id |
|user_name |body.list[] |string | `1111,91,17,*` |用户名字 |
|cstamp |body.list[] |string |2020-01-20 02:19:55 |邀请创建时间 |
```
"list": [
{
"room_id": "15rTsVWR",
"user_name": "洋辣椒",
"type": 1,
"room_name": "15rTsVWR",
"stato": "",
"home_name": "15rTsVWR",
"user_id": "Dt5mvrtE",
"expire": 0,
"home_id": "15rTsVWR",
"cstamp": "2022-09-23 17:34:47",
"id": "FirstROs",
"state": 0,
"ustamp": "2022-09-23 17:34:47"
}
```
#### 调用案例
```
import axios from "axios";
const options = {
method: 'GET',
url: 'http://api.svkernel.xdua.com/rosr',
headers: {
Authorization: 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2NjM5MzM2OTQsIm5iZiI6MTY2MzkzMzY5NCwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2NjM5Mzk2OTQsImF1ZCI6IkNvbnNvbGVFIiwic3ViIjoiRHQ1bXZydEUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiQiIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydEUiLCJhcGkiOiJDcmVhdGVMb2dpbiIsInpvbmUiOiJFbGRyQ2FSRSIsImNvcnAiOiJJY3RKaW5hbiIsInNob3AiOiJGYWNpbGl0eSIsInJvbGUiOiIqIiwicnVsZSI6IioiLCJzYXAiOiJTdktlcm5lTCIsImxnbiI6IjI1ME4xQzF1IiwidGlkIjoiZnZybUtWaksifQ.q_U_2rZJja8EVfBQ4FqPTefwrHxzpzU7vRahCVChA7vciENfT1j2HN9C7eGbCmeBPerJzJlc9pNPCajrWhjRyL_Wnb0nRduKnv8FWXoTz7HCjKEA055ct0_JjQvSaa672BMHdJH44YHFKig_lJhDZIsDnyRl4f-1Lehb3PucSIumvRhskEj_LrkI2pstmDMrmAQ10dwVSN2hbC1Jj4YGSZHNdl8PookNLnAelD8oHFaxIYtRlC2T-V972ilSt4ZIkB6DlKZvGOOJR8w03q91i3Rs6DPApPII6xnHfH0g76Y6eTJTu20oGeeY4yiFN40_69p90lsK0zpzZZ_qlaj9fg'
},
data: {limit: '10', page: '1', sort: 'inc:DESC', where: '{"home_id":"15rTsVWR"}'}
};
axios.request(options).then(function (response) {
console.log(response.data);
}).catch(function (error) {
console.error(error);
});
```
#### 错误码
错误码来自于error字段,通用错误码参考[地球号通用错误码](http://doc.xdua.com/api/errorcodes.html)
# 回收房人。
#### 调用场景
管理员应开发者的要求,登录[超级控制台](http://consolex.xdua.com)后,查询到某个开发者下面的被删除的房人。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的房人的名字。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |RccRosrtmpl | |
|URL |https://api.xdua.com/rosrtmpl| |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS | 只走HTTPS|
|XduaApiMethod |RCC | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | u表示除了允许匿名房人之外的所有房人访问|
|XduaApiRoles |Zoon | 只要登录就可以创建房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |RecycleRosrtmpl | |
|XduaApiRule |RecycleRosrtmpl | |
|XduaApiAstates |0 | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置|类型 |必填 |默认值 |示例 |说明 |
|------- |-----|---------|--------|--------|--------|------------ |
|id |path |string |是 | |rYub4wrT|要删除的房人ID |
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |删除的房人ID |
# 错误码
# 描述
修改房人信息。本接口是Butler可以访问的,Butler几乎可以修改Rosr的所有属性。在未来,Rosr的不重要属性可以被其它角色修改。
#### 调用场景
开发者登录[超级控制台](http://consolex.xdua.com)后,可以修改自己创建的房人。开发者以God角色修改房人。未来可能开放给专门的房人/设备运维。
# 配置参数
参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)
|参数名 |参数值 |说明 |
|------ |------ |---- |
|Name |SetRosr | |
|URL |https://api.xdua.com/rosr | |
|Method |PUT | |
|XduaApiHttpSchema |HTTPS |只走HTTPS|
|XduaApiMethod |SET | |
|XduaApiColor |X | 只有持有神房人,才可以创建房人 |
|XduaApiAudience |ConsoleX | 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop |XdUaXduA | 房人直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject |i | i,只有创建者自己才可以修改|
|XduaApiRoles |Butler | 只要登录就可以创建房人|
|XduaApiResource |rosr | |
|XduaApiKparam |id | |
|XduaApiAction |UpdateRosr | |
|XduaApiRule |UpdateRosr | |
|XduaApiAstates |0 | 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED) |
|XduaApiEnable |true | 接口使能 |
#### 请求参数
|名称 | 位置 |类型 |必填 |默认值 |示例 |说明 |
|------- |----- |--------- |--------|--------|-------- |------------ |
|id |path |String |是 | 无 | 6tYu82hM |房人ID |
|type |body |String |否 | 无 | Mats |房人类型代码,本字段受rosr_type表的code字段外键约束|
|name |body |String |否 | 无 | "803刘姥姥的房间" |房人的平台系统名字,由录入者定义|
> [!note|label:为什么修改操作只能修改type和name?]
> 因为rosr本身就是两个元素room和usro的搭配,修改任何一个的效果等同于删除重建。
#### 返回参数
|名称 | 位置 |类型 |示例 |说明 |
|------- |----- |-----------|------------|------------ |
|id |result |string |rYub4wrT |修改的房人ID |
|updates |result |json dict | |修改的内容 |
#### 示例
result字段
```json
{
"id":"rYub4wrT",
"updates":{
"name":"新的房人名",
"brief":"新的房人介绍",
}
}
```
# 错误码
错误码来自于error字段,通用错误码参考[地球号通用错误码](http://doc.xdua.com/api/errorcodes.html)
# SDK调用
为了方便测试SetRosr
接口。数据库专门提供了一个测试房人rosr_id=TeStTeSt
。可以对这个房人的所有属性进行修改,而不用担心损坏数据库。
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",
})
api_name = "修改房人";
const rosr_id ="TeStTeSt";
const set_params = {
type:"Test",
name:"测试房人",
}
const res_api = await xduaClient.setRosr(rosr_id,set_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash
6. 修改房人。
调用场景
开发者登录超级控制台后,可以修改自己创建的房人。修改仅仅限于可以修改的name,brief等字段。
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
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字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的房人名",
"brief":"新的房人介绍",
}
}
=0表示永远有效。如果大于0表示具体的utc时间。|>