1. 描述

创建触志。

2. 调用场景

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

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

3. 配置参数

参数意义参考接口参数

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

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
type_id body String 触志的种类 触志类型ID,本字段受trglog_type表的id字段外键约束
build_id body String 建筑的ID 触志所在的楼栋,如果不知道就填UnknownB
name body String 触志的名字 触志的名字,可以随意设置
addr body String 触志的地址 触志的地址,是唯一设置的。它和shop_id联动确定是唯一的。

5. 返回参数

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

6. 错误码

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

7. SDK调用



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

/*-----------------------------------------------------------
 * 首先在控制台点击企业按钮,进入企业
 *---------------------------------------------------------*/

api_name = "登续到济南分所";
logon_param = {
    id  :   "IctJinan",
}

res = await xduaClient.addLogon(logon_param)
if(res.status == 200){
    if(res.error == 0){
        got_zone_id = res.result.id;
        console.log(api_name+"成功 ");
    }else{
        got_zone_id = res.result.id;
        console.log(res);
    }
}else{
    console.log(res);
}
/*-----------------------------------------------------------
 * 首先在控制台点击店铺按钮,进入店铺
 *---------------------------------------------------------*/
api_name = "登续到商务中心养老院";
logon_param = {
    id  :   "Facility",
}

res = await xduaClient.addLogon(logon_param)
if(res.status == 200){
    if(res.error == 0){
        got_zone_id = res.result.id;
        console.log(api_name+"成功 ");
    }else{
        got_zone_id = res.result.id;
        console.log(res);
    }
}else{
    console.log(res);
}




/*-----------------------------------------------------------
 * 在店铺界面创建触志
 *---------------------------------------------------------*/
const add_params = {
    build_id:"W0wPuXU3",                             //触志所在的楼栋,`商务中心A座`
    type_id:"m5d00001",                             //触志种类ID,表示`养老院护理间`
    name:"一楼107",                                 //触志的名字
    addr:"商务中心养老公寓主楼107",     //触志地址,这个会做全平台唯一性检查
}



let res = await xduaClient.addRoom(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 |DelRoom | | |URL |https://api.xdua.com/trglog| | |Method |DELETE | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |DEL | | |XduaApiColor |R | 只有持有神触志,才可以创建触志 | |XduaApiAudience |ConsoleR | 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 触志直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有资源创建者自己可以访问这个口| |XduaApiRoles |Butler | Butler可以删除触志| |XduaApiResource |trglog | | |XduaApiKparam |id | | |XduaApiAction |DeleteRoom | | |XduaApiRule |DeleteRoom | | |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 trglog_id ="TeStTeSt"; //要删除的触志ID
let res = await xduaClient.delRoom(trglog_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 |DolRoomtmpl | | |URL |https://api.xdua.com/trglogtmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |DOL | | |XduaApiColor |X | 只有持有神触志,才可以创建触志 | |XduaApiAudience |ConsoleX | 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 触志直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | 只有创建者自己才能删除自己创建的触志| |XduaApiRoles |Zoon | 只要登录就可以创建触志| |XduaApiResource |trglog | | |XduaApiKparam |id | | |XduaApiAction |DeletoRoomtmpl | | |XduaApiRule |DeletoRoomtmpl | | |XduaApiAstates |0 | 按序trglog,zone,corp,shop,trglog,trglog,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 |RccRoomtmpl | | |URL |https://api.xdua.com/trglogtmpl| | |Method |PUT | | |XduaApiHttpSchema |HTTPS | 只走HTTPS| |XduaApiMethod |RCC | | |XduaApiColor |X | 只有持有神触志,才可以创建触志 | |XduaApiAudience |ConsoleX | 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 触志直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | u表示除了允许匿名触志之外的所有触志访问| |XduaApiRoles |Zoon | 只要登录就可以创建触志| |XduaApiResource |trglog | | |XduaApiKparam |id | | |XduaApiAction |RecycleRoomtmpl | | |XduaApiRule |RecycleRoomtmpl | | |XduaApiAstates |0 | 按序trglog,zone,corp,shop,trglog,trglog,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置|类型 |必填 |默认值 |示例 |说明 | |------- |-----|---------|--------|--------|--------|------------ | |id |path |string |是 | |rYub4wrT|要删除的触志ID | # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |id |result |string |rYub4wrT |删除的触志ID | # 错误码 # 描述 修改触志信息。本接口是God可以访问的,God几乎可以修改Room的所有属性。在未来,Room的不重要属性可以被其它角色修改。 # 调用场景 开发者登录[超级控制台](http://consolex.xdua.com)后,可以修改自己创建的触志。开发者以God角色修改触志。未来可能开放给专门的触志/设备运维。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |Settrglog | | |URL |https://api.xdua.com/trglog | | |Method |PUT | | |XduaApiHttpSchema |HTTPS |只走HTTPS| |XduaApiMethod |SET | | |XduaApiColor |X | 只有持有神触志,才可以创建触志 | |XduaApiAudience |ConsoleR | 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 触志直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |i | i,只有创建者自己才可以修改| |XduaApiRoles |Butler | 只要登录就可以创建触志| |XduaApiResource |trglog | | |XduaApiKparam |id | | |XduaApiAction |UpdateRoom | | |XduaApiRule |UpdateRoom | | |XduaApiAstates |0 | 按序trglog,zone,corp,shop,trglog,trglog,login的状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # 请求参数 |名称 | 位置 |类型 |必填 |默认值 |示例 |说明 | |------- |----- |--------- |--------|--------|-------- |------------ | |id |path |String |是 | 无 | 6tYu82hM |触志ID | |type |body |String |否 | 无 | Mats |触志类型代码,本字段受trglog_type表的code字段外键约束| |addr |body |String |否 | 无 | |店铺地址| |name |body |String |否 | 无 | 蓝牙网关 |店铺名字| |build_id |body |String |否 | 无 | 12345678 |触志所属楼栋的ID| # 返回参数 |名称 | 位置 |类型 |示例 |说明 | |------- |----- |-----------|------------|------------ | |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调用

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

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

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

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

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

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

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash
# 描述 查询触志。 # 调用场景 开发者登录[http://consolex.xdua.com](http://consolex.xdua.com)后,可以以God角色查询属于所有触志。 # 配置参数 参数意义参考[接口参数](http://docapi.xdua.com/api/param.html) |参数名 |参数值 |说明 | |------ |------ |---- | |Name |QryApilog | | |URL |https://api.xdua.com/trglog | | |Method |GET | | |XduaApiHttpSchema |HTTPS |只走HTTPS| |XduaApiMethod |QRY | | |XduaApiColor |X | 只有持有神触志,才可以创建触志 | |XduaApiAudience |ConsoleX | 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求| |XduaApiShop |XdUaXduA | 触志直辖店铺,只有这个店铺的登录人员才可以访问| |XduaApiSubject |u | 所有注册触志均可以使用| |XduaApiRoles |God | 必须是Zoon才可以查询角色| |XduaApiResource |trglog | | |XduaApiKparam |`where` | 常量where | |XduaApiAction |QueryApilog | | |XduaApiRule |QueryApilog | | |XduaApiAstates |0 | 所有状态都必须是0(STATE_ENABLED) | |XduaApiEnable |true | 接口使能 | # URL GET:https://api.xdua.com/trglog # 请求参数 参考[标准查询接口请求参数](http://docapi.xdua.com/api/param_query.html) # 返回参数 参考[标准查询接口返回参数](http://docapi.xdua.com/api/param_query.html) result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。 |字段 |显示名称 | 位置 |类型 |示例 |说明 | |------- |------- |----- |-----------|------------ |------------ | |id |ID |result.list[] |string |100003 |触志ID | |name |触发器名 |result.list[] |string | |触志的名称 | |action |触发函数名 |result.list[] |string | |触志店铺的ID | |time |时间 |result.list[] |string |2020-11-18T09:43:24Z |格式如样例所示 | |result |结果 |result.list[] |string |success | | # 错误码 错误码来自于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 = "查询触志";


/*------------------------------------------------------
 * 分页查询店铺(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.qryApilog(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 QriRoomtmpl
URL https://api.xdua.com/trglogtmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRI
XduaApiColor X 只有持有神触志,才可以创建触志
XduaApiAudience ConsoleX 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 触志直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 所有注册触志均可以使用
XduaApiRoles Zoon 必须是Zoon才可以查询角色
XduaApiResource trglog
XduaApiKparam where 常量
XduaApiAction QueriRoomtmpl
XduaApiRule QueriRoomtmpl
XduaApiAstates 0 按序trglog,zone,corp,shop,trglog,trglog,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

11. URL

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

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/trglogtmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GET
XduaApiColor X 只有持有神触志,才可以创建触志
XduaApiAudience ConsoleX 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 触志直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i !表示除了允许匿名触志之外的所有触志访问
XduaApiRoles Zoon 只要Zoon才可以访问其它触志的触志
XduaApiResource trglog
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 触志trglog.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 触志 trglog.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 触志trglog.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
trglog_id string 所属户群的id
trglog_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。如果一个非永远的trglog计算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/trglogtmpl
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神触志,才可以创建触志
XduaApiAudience ConsoleX 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 触志直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的触志
XduaApiRoles Zoon 只要登录就可以创建触志
XduaApiResource trglog
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 触志trglog.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 触志 trglog.state必须是0(STATE_ENABLED)
XduaApiRoomtmplAstate 0 触志trglog.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 DisRoomtmpl
URL https://api.xdua.com/trglogtmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod DIS
XduaApiColor X 只有持有神触志,才可以创建触志
XduaApiAudience ConsoleX 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 触志直辖触志,只有这个触志的登录人员才可以访问
XduaApiSubject i 必须是创建者才可以自闭触志
XduaApiRoles Admin 只有神级管理员才可以关闭普通开发者的触志
XduaApiResource trglog
XduaApiKparam id
XduaApiAction DisableRoomtmpl
XduaApiRule DisableRoomtmpl
XduaApiAstates 0,0 或者0 按序trglog,zone,corp,shop,trglog,trglog,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 EnbRoomtmpl
URL https://api.xdua.com/trglogtmpl
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ENB
XduaApiColor X 只有持有神触志,才可以创建触志
XduaApiAudience ConsoleX 只有trglog_id为ConsoleX的触志,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 触志直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject u 神登录后解冻开发者的触志
XduaApiRoles Admin 只有神才可以解冻触志
XduaApiResource trglog
XduaApiKparam id
XduaApiAction EnableRoomtmpl
XduaApiRule EnableRoomtmpl
XduaApiAstates 0 按序trglog,zone,corp,shop,trglog,trglog,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

36. 请求参数

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

37. 返回参数

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

38. 错误码

39. 描述

下线触志。

40. 调用场景

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

41. 配置参数

参数意义参考接口参数

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

42. 请求参数

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

43. 返回参数

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

44. 错误码

45. 描述

发布触志。

46. 调用场景

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

47. 配置参数

参数意义参考接口参数

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

48. 请求参数

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

49. 返回参数

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

50. 错误码

results matching ""

    No results matching ""