1. 概念定义

户属,就是一个用户的属性,包括性别，年龄，生日，国别。

2. 创建户属

创建户属,就是给用户增加一条或多条属性，可以是生日，性别等。

调用场景

创建户属需要用户先登录自己的账户，进入企业，店铺，然后创建。

配置参数

请求参数

返回参数

错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

SDK调用

3. 批量上传更新用户属性

POST:/usrasi POST:/usras

创建户属组,一次批量上传多个属性。它们不是PUT,而是POST,因为本接口不知道具体的usra资源id.

请求参数

参数名 参数值 说明
atto 用户属性的类别 从管理员那里获取
upserts json序列化后的字符串

返回参数

error为0成功，非0失败。

错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

SDK调用

4. 删除户属。

调用场景

God在超级控制台登录. 它会让资源永久消失。但要删除一个户属，你需要把户属对应的所有设备都删除，才能删除户属。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DelRoom
URL https://api.xdua.com/usra
Method DELETE
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DEL
XduaApiColor R 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleR 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有资源创建者自己可以访问这个口
XduaApiRoles Butler Butler可以删除户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction DeleteRoom
XduaApiRule DeleteRoom
XduaApiAstates 0 所有state检查
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的户属ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的户属ID

错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

SDK调用




const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的删除操作是不会成功的，
 * 因为"TeStTeSt"作为一个测试户属是不可以被删除的。如果为了测试，可以新建一个户属，然后立刻删除。
 *--------------------------*/
const usra_id ="TeStTeSt"; //要删除的户属ID
let res = await xduaClient.delRoom(usra_id)
if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

描述

关闭户属。

调用场景

神管理员登录超级控制台后,可以关闭普通开发者的户属。使得户属进入DISABLED状态，也只有Zoon角色重新打开这个户属。

管理员（Zoon）

  1. 登录http://consoler.{zond_id}.xdua.com后,
  2. 根据条件查询户属，条件是某个户属。
  3. 点击冻结，可以关闭户属。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DisRoomtmpl
URL https://api.xdua.com/usratmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DIS
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖户属,只有这个户属的登录人员才可以访问
XduaApiSubject i 必须是创建者才可以自闭户属
XduaApiRoles Admin 只有神级管理员才可以关闭普通开发者的户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction DisableRoomtmpl
XduaApiRule DisableRoomtmpl
XduaApiAstates 0,0 或者0 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的户属ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的户属ID

错误码

描述

软删户属。

调用场景

开发者登录超级控制台后,可以点击自己的户属，然后删除掉。如果哪天后悔了，可以联系Zoon来恢复。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name DolRoomtmpl
URL https://api.xdua.com/usratmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DOL
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有创建者自己才能删除自己创建的户属
XduaApiRoles Zoon 只要登录就可以创建户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction DeletoRoomtmpl
XduaApiRule DeletoRoomtmpl
XduaApiAstates 0 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的户属ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的户属ID

错误码

描述

打开户属。

调用场景

管理员（Zoon）

  1. 登录http://consolex.xdua.com后,
  2. 根据条件查询户属，条件是某个被冻结的户属。
  3. 点击解冻，可以解冻店铺。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name EnbRoomtmpl
URL https://api.xdua.com/usratmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ENB
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 神登录后解冻开发者的户属
XduaApiRoles Admin 只有神才可以解冻户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction EnableRoomtmpl
XduaApiRule EnableRoomtmpl
XduaApiAstates 0 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的户属ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的户属ID

错误码

描述

详情户属。

调用场景

管理员登录超级控制台后,可以随意查询能看见的所有户属列表。点击其中一个户属（不管是不是自己的），就可以点击访问。

配置参数

参数名 参数值 说明
URL https://api.xdua.com/usratmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GET
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i !表示除了允许匿名户属之外的所有户属访问
XduaApiRoles Zoon 只要Zoon才可以访问其它户属的户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction GetRoomtmpl
XduaApiRule GetRoomtmpl
XduaApiRoomtmplAstate 0 户属zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 户属corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 户属shop.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 户属usra.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 户属 usra.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 户属usra.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
usra_id string 所属户群的id
usra_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 户属请求时客户端的RoomtmplAgent
exp int 户属的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。
vtl int 户属的剩余有效期 ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的usra计算vtl为0时，会自动被重置为-1
ugrp string 户属持有户属所在的户属群,匿名户属的户群是常量:"XdUaXduA"
role string 户属持有户属所在的角色列表,匿名户属的角色列表是常量:"none"
名称 位置 类型 示例 说明
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 辣椒帅 社区创建者名字
updator_id result.list[] string XiyRvUp3 社区最近一次更新者ID
updator_name result.list[] string 周海潮 社区最近一次更新者名字
cstamp result.data string 2020-01-20 02:19:55 户属创建时间
ustamp result.data string 2020-01-20 02:23:24 户属最近更新时间

[!note] 户属的使能状态,0:打开 1:关闭. 关闭的户属处于冻结状态,不接受登陆/注册所有操作.

返回示例

result部分

{
    "id":"rYub4wrT",
    "data": {


    },
}

错误码

描述

私详户属。

调用场景

开发者登录超级控制台后,在户属列表，选择户属，点击详情，就可以查看自己的户属。GIT的默认字段和GET不一样。

配置参数

参数名 参数值 说明
URL https://api.xdua.com/usratmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的户属
XduaApiRoles Zoon 只要登录就可以创建户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction GetRoomtmpl
XduaApiRule GetRoomtmpl
XduaApiRoomtmplAstate 0 户属zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 户属corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 户属shop.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 户属usra.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 户属 usra.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 户属usra.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部分

{
    "id":"rYub4wrT",
    "data": {


    },
}

错误码

描述

下线户属。

调用场景

开发者登录超级控制台后,可以下线自己创建的户属。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffRoomtmpl
URL https://api.xdua.com/usratmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod OFF
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只能户属的创建者才能下线自己的户属
XduaApiRoles Zoon 只要登录就可以创建户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction OfflineRoomtmpl
XduaApiRule OfflineRoomtmpl
XduaApiAstates 0 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的户属ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的户属ID

错误码

描述

发布户属。

调用场景

开发者登录超级控制台后,可以下线/发布自己的户属。这个动作是管理员不能干涉的。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubRoomtmpl
URL https://api.xdua.com/usratmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod PUB
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有户属的创建者自己才能上下线自己的户属
XduaApiRoles Zoon 只要登录就可以创建户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction OnlineRoomtmpl
XduaApiRule OnlineRoomtmpl
XduaApiAstates 0 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的户属ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的户属ID

错误码

5. 私查户属

私查户属。用户查询自己的属性。

URL

GET:https://api.kernel.xdua.com/usrai

调用场景

任何场合，当用户需要知道自己的属性的时候，就用这个接口

请求参数

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

返回参数

公共返回部分参考标准查询接口返回参数。具体返回的数据包含data和list两部分。这是usra接口独特的现象。data是字典格式的。list是列表格式的。

result.data部分

字段key 位置 类型 示例 说明
WXUserProfile.Privilege result string rYub4wrT 微信特权
WXUserProfile.City result string rYub4wrT 微信城市
WXUserProfile.Headimgurl result string 'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIYhTiblmCXm2ekuyvlSkROJ3gMWNZPvw5RXf6Eh97ibBLexRAQQM7hh7uGQ1w9a7PMmJ9mibfT79Hdg/132' 微信头像URL
WXUserProfile.Language result string 'zh_CN' 微信语言
WXUserProfile.Nickname result string '焦帅' 微信昵称
WXUserProfile.Unionid result string o6EyZv2HuY8STp3hLBV9TFOqs84U 微信Unionid
WXUserProfile.Country result string CN 微信国家
WXUserProfile.Sex result string '1' 微信性别
WXUserProfile.Openid result string oA9KU5q5B5163ozPzw1C_GFd7ULc 微信Openid
WXUserProfile.Province result string rYub4wrT 微信省份
XduaUserProfile.Name result string rYub4wrT 地球号用户名字
XduaUserProfile.Bday result string 19670812 地球号用户生日
XduaUserProfile.Sex result string 'u'/'m'/'f' 地球号用户性别。 m=男性,f=女性,u=未知
XduaUserProfile.Avatar result string http://*.webp 地球号用户URL
XduaUserProfile.Tel result string +86-15810419011 地球号用户电话
XduaUserProfile.Mail result string jiaoshuai@gmail.com 地球号用户邮箱

result.list部分

当我们想要用列表格式数据的时候，就需要访问list格式。

名称 位置 类型 示例 说明 id result.list[] string rYub4wrT 详情的户属ID attr result.list[] string 户属的名称 value result.list[] string 户属图标

错误码

示例

微信小程序获取登录用户的名字和性别


`GET: /usrai?attr=*`,获取这个用户的所有字段

`GET: /usrai?attr=XduaUserProfile.Name,XduaUserProfile.Headimgurl` 获取这个用户的微信昵称和微信头像地址

浏览器SDK获取登录用户的名字和性别

let api_name  = "户属查询";
query = {
    where:{attr:"XduaUserProfile.Name,XduaUserProfile.Sex"}
}
let res = await xduaClient.qriUsra(query)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}

//返回数据


{
    "status": 200,
    "apid": "B1D45C25-D39C-4118-A4AA-F271ED8AC494",
    "apis": "QriUsra",
    "error": 0,
    "result": {
        "limit": 20,
        "total": 2,
        "sort": {
            "inc": "DESC"
        },
        "count": 2,
        "page": 1,
        "pages": 1,
        "data": {
            "XduaUserProfile.Sex": "m",
            "XduaUserProfile.Name": "羊辣椒"
        },
        "list": [{
            "id": "Dt5mvrt1",
            "value": "m",
            "attr": "XduaUserProfile.Sex"
        }, {
            "id": "Dt5mvrtE",
            "value": "羊辣椒",
            "attr": "XduaUserProfile.Name"
        }],
        "format": "raw",
        "where": {
            "user_id": "Dt5mvrtE",
            "attr": ["XduaUserProfile.Name", "XduaUserProfile.Sex"]
        },
        "offset": 0
    },
    "debug": [],
    "message": "message",
    "reason": "success"
}

浏览器SDK获取登录用户的所有属性


query = {
    where:{attr:"*"}
}

let res = await xduaClient.qriUsra(query)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}

//返回的数据



{
    "status": 200,
    "apid": "7AE341C7-EAC7-4428-9F34-67C0F2837383",
    "apis": "QriUsra",
    "error": 0,
    "result": {
        "limit": 20,
        "total": 4,
        "sort": {
            "inc": "DESC"
        },
        "count": 4,
        "page": 1,
        "pages": 1,
        "data": {
            "XduaUserProfile.Sex": "m",
            "XduaUserProfile.Tel": "+86-15810419011",
            "XduaUserProfile.Name": "羊辣椒",
            "XduaUserProfile.Mail": "jiaoshuaihit@163.com"
        },
        "list": [{
            "id": "Dt5mvrt3",
            "value": "jiaoshuaihit@163.com",
            "attr": "XduaUserProfile.Mail"
        }, {
            "id": "Dt5mvrt2",
            "value": "+86-15810419011",
            "attr": "XduaUserProfile.Tel"
        }, {
            "id": "Dt5mvrt1",
            "value": "m",
            "attr": "XduaUserProfile.Sex"
        }, {
            "id": "Dt5mvrtE",
            "value": "羊辣椒",
            "attr": "XduaUserProfile.Name"
        }],
        "format": "raw",
        "where": {
            "user_id": "Dt5mvrtE"
        },
        "offset": 0
    },
    "debug": [],
    "message": "message",
    "reason": "success"
}

{ status: 200,
  apid: '9EA7C102-C709-40AD-AED6-61824D6BF4DA',
  apis: 'QriUsra',
  error: 0,
  result:
   { limit: 20,
     total: 10,
     sort: { inc: 'DESC' },
     count: 10,
     page: 1,
     pages: 1,
     data:
      { 'WXUserProfile.City': '',
        'WXUserProfile.Headimgurl':
        'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIYhTiblmCXm2ekuyvlSkROJ3gMWNZPvw5RXf6Eh97ibBLexRAQQM7hh7uGQ1w9a7PMmJ9mibfT79Hdg/132',
        'WXUserProfile.Language': 'zh_CN',
        'WXUserProfile.Nickname': '焦帅',
        'WXUserProfile.Unionid': 'o6EyZv2HuY8STp3hLBV9TFOqs84U',
        'Profile.Ukey': '辣椒帅',
        'WXUserProfile.Country': 'CN',
        'WXUserProfile.Sex': '1',
        'WXUserProfile.Openid': 'oA9KU5q5B5163ozPzw1C_GFd7ULc',
        'WXUserProfile.Province': '' },
     list:
      [ [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object] ],
     format: 'raw',
     where: { shop_id: 'XdUaXduA', user_id: 'Dt5mvrtU' },
     offset: 0 },
  debug: [],
  event:
   '{"body":"","headers":{"CaOpenId.iss":"xdua.com","CaRequestId":"9EA7C102-C709-40AD-AED6-61824D6BF4DA","CaOpenId.bug":"DE","XduaClientDev":"null","XduaApiResource":"usra","CaOpenId.iat":"1604551842","CaRequestHandleTime":"2020-11-05T04:50:42Z","CaAppId":"6151654","XduaApiRule":"QueriUsra","XduaApiAction":"QueriUsra","XduaApiValidQueryWheres":"attr,attr[~]","XduaAcceptLang":"zh","CaOpenId.typ":"U","XduaApiKparam":"state+.+expire","XduaApiColor":"X","CaProxy":"AliCloudAPIGateway","CaApiName":"QriUsra","XduaApiRoles":"*","CaOpenId.lgn":"l7gdGFhi","XduaApiValidQueryFormats":"raw","XduaApiMethod":"QRI","XduaApiValidQueryFilters":"*","CaOpenId.role":"*","XduaApiTokenType":"U","CaClientUa":"axios/0.18.1","CaOpenId.nbf":"1604551842","XduaApiAstates":"0","XduaApiShop":"*","XduaApiVersion":"1.0.0","CaOpenId.sap":"SvKerneL","CaOpenId.exp":"1604552442","Content-Type":"application/x-www-form-urlencoded; charset=UTF-8","CaOpenId.corp":"XdUaXduA","CaOpenId.rule":"*","CaClientIp":"39.97.224.240","X-Ca-Api-Gateway":"9EA7C102-C709-40AD-AED6-61824D6BF4DA","XduaApiSubject":"*","XduaApiHttpSchema":"HTTPS","XduaApiAudience":"*","CaOpenId.own":"Dt5mvrtU","CaOpenId.sub":"Dt5mvrtU","CaOpenId.tid":"Js8j9wok","CaOpenId.aud":"ConsoleX","CaOpenId.tag":"Primary","Authorization":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2MDQ1NTE4NDIsIm5iZiI6MTYwNDU1MTg0MiwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2MDQ1NTI0NDIsImF1ZCI6IkNvbnNvbGVYIiwic3ViIjoiRHQ1bXZydFUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiWCIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydFUiLCJzYXAiOiJTdktlcm5lTCIsImFwaSI6IkFkZFRvZ2lueCIsInpvbmUiOiJYZFVhWGR1QSIsImNvcnAiOiJYZFVhWGR1QSIsInNob3AiOiJYZFVhWGR1QSIsInJvbGUiOiIqIiwicnVsZSI6IioiLCJidWciOiJERSIsInRpZCI6IkpzOGo5d29rIiwibGduIjoibDdnZEdGaGkifQ.mh3HE6yTCCSJ-5e7Lhk_XnWnNd5glhTBYqrrIaArZjl4ljE71UmA4UoDyU_cLRWWdUgnNvXRvsjH2c2hofelMVHDHB0H6d9xUJ_6_4Qy8NPHlxHwA8YfDOIco92R4HVER9CXCb-Kj7YZs3GqdO5mqL3711Swx5cEBN6I68yrWKbPPq5jdj9OxMK7wbFbytRIHtDA_VYfIzu5pFF1p-KLfi0OSt6a5W5XXhZUkxAqAiKjJEGCskaaOLX0rUhbmc25tHJdZ1hqHK9FY5josyhE0o04dFcyrYz7dqk7ZuZ4TeS1IBnCqFzmLRYzpvVrdnlrb5N5GwqPmuMenv65E4WY7A","XduaApiValidQuerySchemas":"*","CaHttpSchema":"HTTP","XduaApiValidQueryFields":"@all,*","CaDomain":"api.svkernel.xdua.com","CaOpenId.clr":"X","CaOpenId.jti":"12345678","CaOpenId.dvm":"*","XduaApiEnable":"true","CaOpenId.ipm":"*","X-Forwarded-For":"39.97.224.240","CaOpenId.api":"AddToginx","CaOpenId.shop":"XdUaXduA","CaOpenId.zone":"XdUaXduA"},"httpMethod":"GET","isBase64Encoded":false,"path":"/usrai","pathParameters":{},"queryParameters":{"limit":"20","schema":"*","sort":"inc:DESC","page":"0","format":"raw","offset":"0","where":"{}","filter":"*","fields":"*"}}',
  message: '成功。',
  reason: '成功' }

描述

查询户属。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
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 接口使能

URL

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

请求参数

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

返回参数

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

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 户属最近更新时间

错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

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

描述

回收户属。

调用场景

管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的户属。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的户属的名字。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccRoomtmpl
URL https://api.xdua.com/usratmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod RCC
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleX 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i u表示除了允许匿名户属之外的所有户属访问
XduaApiRoles Zoon 只要登录就可以创建户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction RecycleRoomtmpl
XduaApiRule RecycleRoomtmpl
XduaApiAstates 0 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的户属ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的户属ID

错误码

描述

修改户属信息。本接口是God可以访问的，God几乎可以修改Room的所有属性。在未来，Room的不重要属性可以被其它角色修改。

调用场景

开发者登录超级控制台后,可以修改自己创建的户属。开发者以God角色修改户属。未来可能开放给专门的户属/设备运维。

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name Setusra
URL https://api.xdua.com/usra
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神户属，才可以创建户属
XduaApiAudience ConsoleR 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户属直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Butler 只要登录就可以创建户属
XduaApiResource usra
XduaApiKparam id
XduaApiAction UpdateRoom
XduaApiRule UpdateRoom
XduaApiAstates 0 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path String 是 无 6tYu82hM 户属ID
type body String 否 无 Mats 户属类型代码,本字段受usra_type表的code字段外键约束
addr body String 否 无 店铺地址
name body String 否 无 蓝牙网关 店铺名字
build_id body String 否 无 12345678 户属所属楼栋的ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的户属ID
updates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的户属名",
        "brief":"新的户属介绍",    
    }    
}

错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

SDK调用

为了方便测试SetRoom接口。数据库专门提供了一个测试户属usra_id=TeStTeSt。可以对这个户属的所有属性进行修改,而不用担心损坏数据库。

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------

  • 运行如下代码
  • 下面的代码是直接可以运行的 --------------------------/ api_name = "修改户属"; const usra_id ="TeStTeSt"; //要修改的户属ID

/*----------------------------

  • 下面展示的是修改"TeStTeSt"所有属性的操作，实际上可以只修改其中任何一个到两个参数 --------------------------/ const set_params = { type:"Room", //户属新的类型 name:"测试户属", //名字 addr:"户属新的地址", //户属生产商 }

const res_api = await xduaClient.setRoom(usra_id,set_params)

if(res.error == 0){ console.log("测试成功");
}else{ console.log("测试失败");
console.log(res); } </code></pre> </div>

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

</code></pre>
</div></div></div>
#### 描述

修改户属。

#### 调用场景

开发者登录[超级控制台](http://consolex.xdua.com)后,可以修改自己创建的户属。修改仅仅限于可以修改的name,brief等字段。


#### 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|Name                   |SetRoomtmpl                  |         |
|URL                    |https://api.xdua.com/usratmpl|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |SET                      |         |
|XduaApiColor      |X                        | 只有持有神户属，才可以创建户属        |
|XduaApiAudience   |ConsoleX                 | 只有usra_id为ConsoleX的户属，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 户属直辖店铺,只有这个店铺的登录人员才可以访问|
|XduaApiSubject    |i                        | i,只有创建者自己才可以修改|
|XduaApiRoles           |Zoon                     | 只要登录就可以创建户属|
|XduaApiResource        |usra                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |UpdateRoomtmpl               |     |
|XduaApiRule            |UpdateRoomtmpl               |     |
|XduaApiAstates         |0              | 按序usra,zone,corp,shop,usra,usra,login的状态都必须是0(STATE_ENABLED)    |
|XduaApiEnable          |true                     | 接口使能    |


#### 请求参数

|名称       | 位置|类型     |必填    |默认值  |示例    |说明                |
|-------    |-----|---------|--------|--------|--------|------------        |
|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字段

```json
{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的户属名",
        "brief":"新的户属介绍",    
    }    
}

错误码

results matching ""

    No results matching ""