简要描述:
- 查询当前用户和合并账号分享后入库的用户,便于积分关联以及营销裂变
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
v3 | 陈碧贵 | 2021-08-31 | xxxx-xx-xx |
请求URL:
http://{url参数}/bo/api/v3/{mkey}/page/res/{resField}?_nodejs=common-data&pageSize=10&pageIndex=1
- {mkey} 对应mapper文件
- {resField} 对应 {mkey}里面 responseField键
请求方式:
- GET
- POST
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
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": [
{
"fromFirstShareId": "3951617521341173760",
"fromSecondShareId": "3951617521341173760",
"userId": "3951624143140556800",
"diffTableNo": 0,
"createDate": {
"name": "2021-08-31",
"value": "2021-08-31T11:11:36"
},
"firstShare": {
"userId": "3951617521341173760",
"nikeName": "test3",
"pushName": "test3",
"headIcon": "1.jpg",
"diffTableNo": 1
},
"fromUser": {
"userId": "3951624143140556800",
"nikeName": "demo678",
"pushName": "demo678",
"headIcon": "1.jpg",
"diffTableNo": 1
},
"secondShare": {
"userId": "3951617521341173760",
"nikeName": "test3",
"pushName": "test3",
"headIcon": "1.jpg",
"diffTableNo": 1
},
"shareStatus":{
"name":null,
"value":null
}
}
],
"cacheDate": "2021-08-31T11:21:43",
"code": "0",
"retCode": "0",
"success": true,
"paging": {
"pageSize": 15,
"totalCount": 4,
"totalPage": 1,
"pageIndex": 1,
"currentCount": 4,
"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 | firstShare:一级分享用户;secondShare:二级分享用户;shareStatus:分享处理状态 0;未处理,1、 已获取积分;2、无积分;响应的结果数据 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// 开始读取的索引 |
文档更新时间: 2021-08-31 08:00 作者:admin