1. 描述

查询城区。

2. SDK调用

const api_param = {
    limit:5
}
let api_res = await xduaClient.addLoginr(api_param)
</div></div># 调用场景

管理员登录超级控制台后,可以以God角色查询平台上所有城区。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryArea
URL https://api.xdua.com/area
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRY
XduaApiColor X 只有持有神令牌，才可以创建城区
XduaApiAudience ConsoleX 只有area_id为ConsoleX的城区，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 城区直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 所有注册用户均可以使用
XduaApiRoles God 必须是God才可以查询角色
XduaApiResource area
XduaApiKparam where 常量where
XduaApiAction QueryArea
XduaApiRule QueryArea
XduaApiAareas 0 按序area,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

4. 请求参数

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

5. 返回参数

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

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的城区ID
name result.list[] string 城区的名称
avatar result.list[] string 城区图标
brief result.list[] string 城区的描述
area 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 辣椒帅 城区创建者名字
ipdator_id result.list[] string XiyRvUp3 城区最近一次更新者ID
ipdator_name result.list[] string 周海潮 城区最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 城区创建时间
istamp result.list[] string 2020-01-20 02:23:24 城区最近更新时间

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的城区ID
name result.list[] string 城区的名称
avatar result.list[] string 城区图标
brief result.list[] string 城区的描述
area 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 辣椒帅 城区创建者名字
ipdator_id result.list[] string XiyRvUp3 城区最近一次更新者ID
ipdator_name result.list[] string 周海潮 城区最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 城区创建时间
istamp result.list[] string 2020-01-20 02:23:24 城区最近更新时间

6. 错误码

results matching ""

    No results matching ""