1. 描述

查询房物。

2. 调用场景

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

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryRood
URL https://api.xdua.com/rood
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRY
XduaApiColor X 只有持有神房物，才可以创建房物
XduaApiAudience ConsoleX 只有rood_id为ConsoleX的房物，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 房物直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 所有注册房物均可以使用
XduaApiRoles God 必须是Zoon才可以查询角色
XduaApiResource rood
XduaApiKparam where 常量where
XduaApiAction QueryRood
XduaApiRule QueryRood
XduaApiAstates 0 所有状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

4. URL

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

5. 请求参数

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

支持的查询参数

名称 位置 类型 示例 说明
room_id where string rYub4wrT 详情的房物ID
name where string 房物的名称精确查询
name[~] where string 房物的名称模糊查询

6. 返回参数

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

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

名称 位置 类型 示例 说明
id result.list[] string rYub4wrT 详情的房物ID
name result.list[] string 房物的名称
type_id result.list[] string 房间种类的ID
type_name result.list[] string 房物种类的名字
room_id result.list[] string 房间的ID
room_name result.list[] string 房间的名字
devp_id result.list[] string 产品的ID
devp_name result.list[] string 产品的名字
dev_id result.list[] string 设备的ID
dev_vstr result.list[] string 设备的数值
dev_vgtw 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 = "查询房物";

let query_param = {
    limit:20,
    page:1,
    where:{"name[~]":"%卧室%"}    
}

/*---------------------------------------
 * 查询room_id=="9COkOKGl"下的所有rood
 * 下面的代码是直接可以运行的
 *-------------------------------------*/

let query_param = {
    limit:20,
    page:1,
    where:{room_id  :   "9COkOKGl"}    
}

const res_api = await xduaClient.qryRood(query_params)

if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

results matching ""

    No results matching ""