1. 描述

详情套房。

2. 调用场景

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

3. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/hometmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GET
XduaApiColor X 只有持有神套房,才可以创建套房
XduaApiAudience ConsoleX 只有home_id为ConsoleX的套房,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 套房直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i !表示除了允许匿名套房之外的所有套房访问
XduaApiRoles Zoon 只要Zoon才可以访问其它套房的套房
XduaApiResource home
XduaApiKparam id
XduaApiAction GetHometmpl
XduaApiRule GetHometmpl
XduaApiHometmplAstate 0 套房zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 套房corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 套房shop.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 套房home.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 套房 home.state必须是0(STATE_ENABLED)
XduaApiHometmplAstate 0 套房home.state必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string rYub4wrT 要修改的套房ID

5. 返回参数

名称 位置 类型 示例 说明
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
home_id string 所属户群的id
home_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 套房请求时客户端的HometmplAgent
exp int 套房的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。
vtl int 套房的剩余有效期 ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的home计算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": {


    },
}

6. 错误码

results matching ""

    No results matching ""