1. 描述
查询套房。
2. 调用场景
开发者登录http://consolex.xdua.com后,可以以God角色查询属于所有套房。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryHome | |
URL | https://api.xdua.com/home | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神套房,才可以创建套房 |
XduaApiAudience | ConsoleX | 只有home_id为ConsoleX的套房,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 套房直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册套房均可以使用 |
XduaApiRoles | God | 必须是Zoon才可以查询角色 |
XduaApiResource | home | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryHome | |
XduaApiRule | QueryHome | |
XduaApiAstates | 0 | 所有状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
4. URL
5. 请求参数
6. 返回参数
6.1. fields为@all时返回的参数
result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result.list[] | string | rYub4wrT | 详情的套房ID |
name | result.list[] | string | 套房的名称 | |
rank | result.list[] | int | 套房的排序 | |
note | result.list[] | int | 套房信息的备注 | |
type_id | result.list[] | string | 套房种类的ID | |
type_name | result.list[] | string | 套房种类的名 | |
vila_id | result.list[] | string | 套房小区的ID | |
vila_name | result.list[] | string | 套房小区的名 | |
home_id | result.list[] | string | 套房套房的ID | |
home_name | result.list[] | string | 套房套房的名 | |
shop_id | result.list[] | string | 套房店铺的ID | |
shop_name | 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 | 辣椒帅 | 套房创建者名字 |
updator_id | result.list[] | string | XiyRvUp3 | 套房最近一次更新者ID |
updator_name | result.list[] | string | 周海潮 | 套房最近一次更新者名字 |
cstamp | result.list[] | string | 2020-01-20 02:19:55 | 套房创建时间 |
ustamp | result.list[] | string | 2020-01-20 02:23:24 | 套房最近更新时间 |
7. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
8. SDK调用
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.qryHome(query_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash