1. 描述

创建楼栋。

2. 调用场景

开发者登录超级控制台后,可以以God角色创建自己的楼栋。楼栋创建目前只能由God进行。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddBuild
Url https://api.xdua.com/build
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神楼栋,才可以创建楼栋
XduaApiAudience ConsoleX 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 楼栋直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 需要登录
XduaApiRole God 目前地球号只允许God添加楼栋,未来这个功能会让给一个专门维护楼栋和设备录入的角色。
XduaApiResource build
XduaApiKparam pkey 在阿里云物联网平台创建的楼栋的ProductKey
XduaApiAction CreateBuild
XduaApiRule CreateBuild
XduaApiAstates 0 所有的资源都要确认state是0
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
type body String Mats 楼栋类型代码,本字段受build_type表的code字段外键约束
man body String Minew 制造商代码,本字段受build_man表的code字段外键约束
model body String Minew 制造商代码,从楼栋的包装盒,介绍中获取
name body String Minew 楼栋的平台系统名字,由录入者自定义
vlot body Integer 3600 楼栋的日志存活时间
brief body String 这是一个* 楼栋的介绍
cost body Double 45.0 楼栋的采购价格或者平摊下来的生产制造价格
earn body Double 60.0 对外销售价格,包含设置人工成本

5. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的楼栋ID

6. 错误码

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

7. SDK调用



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

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
const add_params = {
    type:"Test",        //类别
    model:"Motest2",    //型号,Motest这个词取自Model Test合词
    vlot:360,           //本楼栋对应的所有设备的数据在日志表里存6分钟数据
    name:"测试楼栋",    //名字
    man:"xdua.com",     //楼栋生产商,地球号团队制作的硬件的生产商是xuda.com
    pkey:"a1lPKOTest2", //阿里云平台ProductKey,从那里拷贝过来
    brief:"接口测试",   //简介
    cost:45,            //采购或者生产这个硬件的成本
    earn:60,            //对外销售价格
}

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash
# 描述 删除楼栋。 # 调用场景 God在[超级控制台](http://consolex.xdua.com)登录. 它会让资源永久消失。但要删除一个楼栋,你需要把楼栋对应的所有设备都删除,才能删除楼栋。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |DelBuild | | |URL |https://api.xdua.com/build| | |Method |DELETE | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |DEL | | |XduaApiColor |X | 只有持有神楼栋,才可以创建楼栋 | |XduaApiAudience |ConsoleX | 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 楼栋直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有资源创建者自己可以访问这个口| |XduaApiRoles |God | Zoon可以删除楼栋| |XduaApiResource |build | | |XduaApiKparam |id | | |XduaApiAction |DeleteBuild | | |XduaApiRule |DeleteBuild | | |XduaApiAstates |0 | 所有state检查 | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要删除的楼栋ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |删除的楼栋ID | # 错误码 错误码来自于error字段,通用错误码参考[地球号通用错误码](http://doc.xdua.com/api/errorcodes.html) # SDK调用


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

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash
# 描述 软删楼栋。 # 调用场景 开发者登录[超级控制台](http://consolex.xdua.com)后,可以点击自己的楼栋,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |DolBuildtmpl | | |URL |https://api.xdua.com/buildtmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |DOL | | |XduaApiColor |X | 只有持有神楼栋,才可以创建楼栋 | |XduaApiAudience |ConsoleX | 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 楼栋直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有创建者自己才能删除自己创建的楼栋| |XduaApiRoles |Zoon | 只要登录就可以创建楼栋| |XduaApiResource |build | | |XduaApiKparam |id | | |XduaApiAction |DeletoBuildtmpl | | |XduaApiRule |DeletoBuildtmpl | | |XduaApiAstates |0 | 按序build,zone,corp,shop,build,build,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要删除的楼栋ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |删除的楼栋ID | # 错误码 # 描述 回收楼栋。 # 调用场景 管理员应开发者的要求,登录[超级控制台](http://consolex.xdua.com)后,查询到某个开发者下面的被删除的楼栋。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的楼栋的名字。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |RccBuildtmpl | | |URL |https://api.xdua.com/buildtmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |RCC | | |XduaApiColor |X | 只有持有神楼栋,才可以创建楼栋 | |XduaApiAudience |ConsoleX | 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 楼栋直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | u表示除了允许匿名楼栋之外的所有楼栋访问| |XduaApiRoles |Zoon | 只要登录就可以创建楼栋| |XduaApiResource |build | | |XduaApiKparam |id | | |XduaApiAction |RecycleBuildtmpl | | |XduaApiRule |RecycleBuildtmpl | | |XduaApiAstates |0 | 按序build,zone,corp,shop,build,build,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要删除的楼栋ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |删除的楼栋ID | # 错误码 # 描述 修改楼栋信息。本接口是God可以访问的,God几乎可以修改Build的所有属性。在未来,Build的不重要属性可以被其它角色修改。 # 调用场景 开发者登录[超级控制台](http://consolex.xdua.com)后,可以修改自己创建的楼栋。开发者以God角色修改楼栋。未来可能开放给专门的楼栋/设备运维。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |Setbuild | | |URL |https://api.xdua.com/build | | |Method |PUT | | |XduaApiHttpSchema |HTTPS |只走HTTPS| |XduaApiMethod |SET | | |XduaApiColor |X | 只有持有神楼栋,才可以创建楼栋 | |XduaApiAudience |ConsoleX | 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 楼栋直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | i,只有创建者自己才可以修改| |XduaApiRoles |God | 只要登录就可以创建楼栋| |XduaApiResource |build | | |XduaApiKparam |id | | |XduaApiAction |UpdateBuild | | |XduaApiRule |UpdateBuild | | |XduaApiAstates |0 | 按序build,zone,corp,shop,build,build,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置 |类型 |必填 |默认值 |示例 |说明 | |------- |----- |--------- |--------|--------|-------- |------------ | |id |path |String |是 | 无 | 6tYu82hM |楼栋ID | |type |body |String |否 | 无 | Mats |楼栋类型代码,本字段受build_type表的code字段外键约束| |man |body |String |否 | 无 | Minew |制造商代码,本字段受build_man表的code字段外键约束| |model |body |String |否 | 无 | CBOX-7 |制造商代码,从楼栋的包装盒,介绍中获取| |name |body |String |否 | 无 | 蓝牙网关 |楼栋的平台系统名字,由录入者自定义| |vlot |body |Integer |否 | 无 | 3600 |楼栋的日志存活时间| |brief |body |String |否 | 空 | 这是一个* |楼栋的介绍| |cost |body |Double |是 | 空 | 45.0 |楼栋的采购价格或者平摊下来的生产制造价格| |earn |body |Double |是 | 空 | 60.0 |对外销售价格,包含设置人工成本| # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |修改的楼栋ID | |updates |result |json dict | |修改的内容 | #### 示例 result字段 ```json { "id":"rYub4wrT", "updates":{ "name":"新的楼栋名", "brief":"新的楼栋介绍", } } ``` # 错误码 错误码来自于error字段,通用错误码参考[地球号通用错误码](http://doc.xdua.com/api/errorcodes.html) # SDK调用

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

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

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
api_name = "修改楼栋";
const build_id ="TeStTeSt"; //要修改的楼栋ID

/*----------------------------
 * 下面展示的是修改"TeStTeSt"所有属性的操作,实际上可以只修改其中任何一个到两个参数
 *--------------------------*/
const set_params = {
    type:"Test",        //类别
    model:"Motest3",    //型号
    vlot:360,           //它在日志表里存6分钟数据
    name:"测试楼栋",    //名字
    man:"xdua.com",     //楼栋生产商
    pkey:"a1lPKOTest2", //阿里云平台ProductKey,从那里拷贝过来
    brief:"接口测试",   //简介
    earn:65,            //价格
    cost:45,            //成本
}

const res_api = await xduaClient.setBuild(build_id,set_params)

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash
# 描述 修改楼栋。 # 调用场景 开发者登录[超级控制台](http://consolex.xdua.com)后,可以修改自己创建的楼栋。修改仅仅限于可以修改的name,brief等字段。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |SetBuildtmpl | | |URL |https://api.xdua.com/buildtmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |SET | | |XduaApiColor |X | 只有持有神楼栋,才可以创建楼栋 | |XduaApiAudience |ConsoleX | 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 楼栋直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | i,只有创建者自己才可以修改| |XduaApiRoles |Zoon | 只要登录就可以创建楼栋| |XduaApiResource |build | | |XduaApiKparam |id | | |XduaApiAction |UpdateBuildtmpl | | |XduaApiRule |UpdateBuildtmpl | | |XduaApiAstates |0 | 按序build,zone,corp,shop,build,build,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":"新的楼栋介绍", } } ``` # 错误码 # 描述 查询楼栋。 # 调用场景 开发者登录[http://consolex.xdua.com](http://consolex.xdua.com)后,可以以God角色查询属于所有楼栋。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |QryBuild | | |URL |https://api.xdua.com/build | | |Method |GET | | |XduaApiHttpSchema |HTTPS |只走HTTPS| |XduaApiMethod |QRY | | |XduaApiColor |X | 只有持有神楼栋,才可以创建楼栋 | |XduaApiAudience |ConsoleX | 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 楼栋直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |u | 所有注册楼栋均可以使用| |XduaApiRoles |God | 必须是Zoon才可以查询角色| |XduaApiResource |build | | |XduaApiKparam |`where` | 常量where | |XduaApiAction |QueryBuild | | |XduaApiRule |QueryBuild | | |XduaApiAstates |0 | 所有状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # URL GET:https://api.xdua.com/build # 请求参数 参考[标准查询接口请求参数](http://docapi.xdua.com/api/param_query.html) # 返回参数 参考[标准查询接口返回参数](http://docapi.xdua.com/api/param_query.html) ## fields为@all时返回的参数 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字段,通用错误码参考[地球号通用错误码](http://doc.xdua.com/api/errorcodes.html) # SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
api_name = "查询楼栋";


/*------------------------------------------------------
 * 分页查询制造商Minew的所有楼栋,显示第2页,每页显示20条
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{man:"Minew"}    
}

/*------------------------------------------------------
 * 分页查询不是制造商Minew的所有楼栋,显示第2页,每页显示20条
 *----------------------------------------------------*/

let query_param = {
    limit:20,
    page:2,
    where:{"man[!]":"Minew"}    
}

/*------------------------------------------------------
 * 分页查询制造商是Minew和xdua.com的所有楼栋,显示第1页,每页显示20条
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:2,
    where:{
        man:["Minew","xdua.com"],
    }    
}

/*------------------------------------------------------
 * 分页查询楼栋名字是`虚拟网关`
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        name:"虚拟网关",
    }    
}

/*------------------------------------------------------
 * 分页查询楼栋名字包含`网关`二字,这是一种模糊查询方式,注意两点
 * 1. 要有`[~]`
 * 2. 字串模糊的地方要有%,`%网关%`表示前后都可能有其它串,`%网关`表示必须以`网关`结尾。
 *----------------------------------------------------*/
let query_param = {
    limit:20,
    page:1,
    where:{
        "name[~]":"%网关%",
    }    
}



const res_api = await xduaClient.qryBuild(query_params)

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

8. 描述

私查楼栋。

9. 调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有楼栋。

10. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriBuildtmpl
URL https://api.xdua.com/buildtmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRI
XduaApiColor X 只有持有神楼栋,才可以创建楼栋
XduaApiAudience ConsoleX 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 楼栋直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 所有注册楼栋均可以使用
XduaApiRoles Zoon 必须是Zoon才可以查询角色
XduaApiResource build
XduaApiKparam where 常量
XduaApiAction QueriBuildtmpl
XduaApiRule QueriBuildtmpl
XduaApiAstates 0 按序build,zone,corp,shop,build,build,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

11. URL

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

12. 请求参数

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

13. 返回参数

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

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的楼栋ID
name result.list[] string 楼栋的名称
avatar result.list[] string 楼栋图标
brief 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 辣椒帅 楼栋创建者名字
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 楼栋最近更新时间

14. 错误码

15. 描述

详情楼栋。

16. 调用场景

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

17. 配置参数

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

18. 请求参数

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

19. 返回参数

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


    },
}

20. 错误码

21. 描述

私详楼栋。

22. 调用场景

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

23. 配置参数

参数名 参数值 说明
URL https://api.xdua.com/buildtmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神楼栋,才可以创建楼栋
XduaApiAudience ConsoleX 只有build_id为ConsoleX的楼栋,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 楼栋直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的楼栋
XduaApiRoles Zoon 只要登录就可以创建楼栋
XduaApiResource build
XduaApiKparam id
XduaApiAction GetBuildtmpl
XduaApiRule GetBuildtmpl
XduaApiBuildtmplAstate 0 楼栋zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 楼栋corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 楼栋shop.state必须是0(STATE_ENABLED)
XduaApiBuildtmplAstate 0 楼栋build.state必须是0(STATE_ENABLED)
XduaApiBuildtmplAstate 0 楼栋 build.state必须是0(STATE_ENABLED)
XduaApiBuildtmplAstate 0 楼栋build.state必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

24. 请求参数

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

25. 返回参数

名称 位置 类型 示例 说明
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": {


    },
}

26. 错误码

27. 描述

关闭楼栋。

28. 调用场景

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

管理员(Zoon)

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

29. 配置参数

参数意义参考接口参数

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

30. 请求参数

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

31. 返回参数

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

32. 错误码

33. 描述

打开楼栋。

34. 调用场景

管理员(Zoon)

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

35. 配置参数

参数意义参考接口参数

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

36. 请求参数

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

37. 返回参数

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

38. 错误码

39. 描述

下线楼栋。

40. 调用场景

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

41. 配置参数

参数意义参考接口参数

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

42. 请求参数

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

43. 返回参数

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

44. 错误码

45. 描述

发布楼栋。

46. 调用场景

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

47. 配置参数

参数意义参考接口参数

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

48. 请求参数

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

49. 返回参数

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

50. 错误码

results matching ""

    No results matching ""