简要描述:
接口版本:
版本号 |
制定人 |
制定日期 |
修订日期 |
v3 |
陈碧贵 |
2021-09-27 |
xxxx-xx-xx |
请求URL:
- {mkey} 对应mapper文件
- {resField} 对应 {mkey}里面 responseField键
请求方式:
请求头:
参数名 |
是否必须 |
类型 |
说明 |
XownerId |
是 |
string |
项目唯一ID,对应bo_project {ownerId} |
XsysId |
否 |
string |
所属系统 对应 bo_system 表 |
XuserFromFirstShareId |
string |
否 |
一级分享用户ID, bo_user user_id |
XuserFromSecondShareId |
string |
否 |
二级分享用户ID, bo_user user_id |
XverifyApi |
是 |
string |
加密规则encryptByDES(`${newGuid()} |
XfilterAreaCode |
否 |
string |
行政区编码, 对应 bo_sys_area area_code |
Content-Type: |
是 |
string |
application/json; charset=utf-8 请求类型 |
请求参数:
- 当事件发生时,调用http/https接口,传递参数信息,响应请求结果。
参数名 |
是否必须 |
类型 |
说明 |
pageSize |
是 |
string |
当前显示记录数 |
pageIndex |
是 |
string |
当前第页数,1表示第一页 |
_nodejs |
是 |
string |
common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线 |
返回示例:
正确时返回:
{
"data": [
{
"chatId": "bt-deve-bt-20200-3329b1f8-0f68-4a6b",
"type":{
"name":"站内、支付、登录",
"value":"site、pay、login"
},
"title": "案例t",
"content": "FADAOFANFOU",
"diffTableNo": 0,
"createTime": {
"name": "2021-01-01",
"value": "2021-01-01T00:00:00"
},
"statusWechatEnt": {
"name": "企业微信1 已读 0未读 2 未发送 3 已发送 4 不推送",
"value": "1"
},
"statusWechat": {
"name": "微信1 已读 0未读 2 未发送 3 已发送 4 不推送",
"value": "1"
},
"statusEmail": {
"name": "邮箱1 已读 0未读 2 未发送 3 已发送 4 不推送",
"value": "1"
},
"statusTelephone": {
"name": "手机1 已读 0未读 2 未发送 3 已发送 4 不推送",
"value": "1"
},
"statusSite": {
"name": "站内1 已读 0未读 2 未发送 3 已发送 4 不推送",
"value": "1"
},
"createUserId":{
"name": "用户名",
"value": "userId"
}
}
],
"cacheDate": "2021-01-22T12:25:11",
"code": 0,
"success": true,
"paging": {
"pageSize": 10,
"totalCount": 2,
"totalPage": 0,
"pageIndex": 1,
"currentCount": 2,
"currentRate": 100,
"limtStartIndex": 0
}
}
错误时返回:
{
"code": 0,
"message": ""
"error":{
errorCode:null,
errorText:null
}
"success": false,
}
返回参数说明:
参数名 |
类型 |
说明 |
success |
bool |
true 表示数据请求成功(跟code=0一致),调用者优先使用 |
code |
int |
true 表示数据请求成功(跟code=0一致),调用者优先使用 |
data |
array |
响应的结果数据 name:显示的名称 value:交互的数据库中值 id:通常和value一致,树形结构需要 parentId: 父节点,树形结构需要level:等级,树形结构需要 |
cacheType |
string |
redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化) |
cacheDate |
date |
最后数据获取时间 |
paging |
object |
“pageSize”: 10, //当前页请求记录数 “totalCount”: 2,//数据总记录数 “totalPage”: 0,//数据总共几页 “pageIndex”: 1,//当前第几页”currentCount”: 2,//当前显示的总记录数”currentRate”: 100,//当前显示记录占比%”limtStartIndex”: 0// 开始读取的索引 |
状态类别
{
"success": true,
"data": [
{
"value": "site",
"type": "msgtype",
"name": "站内"
},
{
"value": "login",
"type": "msgtype",
"name": "登录"
},
{
"value": "pay",
"type": "msgtype",
"name": "支付"
},
{
"value": "order",
"type": "msgtype",
"name": "订单"
}
]
}
{
"success": true,
"data": [
{
"value": "0",
"type": "msgstatus",
"name": "未读取"
},
{
"value": "1",
"type": "msgstatus",
"name": "已读取"
},
{
"value": "2",
"type": "msgstatus",
"name": "未发送"
},
{
"value": "3",
"type": "msgstatus",
"name": "已发送"
},
{
"value": "4",
"type": "msgstatus",
"name": "不推送"
}
]
}
文档更新时间: 2021-09-28 08:16 作者:admin