1. 描述

查询户属。

2. 调用场景

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

3. 配置参数

参数意义参考接口参数

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

4. URL

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

5. 请求参数

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

6. 返回参数

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

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 户属小区的名
shop_id result.list[] string 户属店铺的ID
shop_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 = "查询户属";


/*------------------------------------------------------
 * 分页查询店铺(shop_id)下的所有户属,
 * 比方说,某个养老院的所有户属
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{shop_id:"Facility"}    
}

/*------------------------------------------------------
 * 查询户属名字的模糊查询
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{"name[~]":"%济南市%"}    
}

/*------------------------------------------------------
 * 分页查询小区`Vila0001`下的户属
 * 
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        vila_id:"Vila0001",
    }    
}


const res_api = await xduaClient.qryRoom(query_params)

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

results matching ""

    No results matching ""