简要描述:
- 【活动】根据活动编号获取活动信息(包括奖品、轮次、图文)
接口版本:
版本号 |
制定人 |
制定日期 |
修订日期 |
v3 |
陈碧贵 |
2024-01-10 |
xxxx-xx-xx |
请求URL:
请求方式:
请求头:
参数名 |
是否必须 |
类型 |
说明 |
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 请求类型 |
请求参数:
{}
参数名 |
是否必须 |
类型 |
说明 |
activityId |
是 |
string |
活动编号 |
_nodejs |
是 |
string |
common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线 |
返回示例:
正确时返回:
{
"data": {
"tags": [],
"awards": [
{
"arId": "4264488060600717312",
"activityId": "4248218677855391745",
"activityName": "活动标题",
"roundName": "第二轮",
"awardName": "奖品2",
"awardNum": 90,
"imgUrl": "",
"diffTableNo": 1,
"awardId": {
"name": "奖品2",
"value": "4260185418177187841"
},
"isEnabled": {
"value": 1
},
"roundId": {
"name": "第二轮",
"value": "4260202088757202945"
}
}
],
"graphics": [
{
"contentId": "4259468696386277377",
"cstTitle": "88",
"activityId": "4248218677855391745",
"activityName": "活动标题",
"cstVideoUrl": "",
"cstVideoRoom": "",
"cstVideoPswd": "",
"cstWebImgUrl": "",
"cstAppImgUrl": "",
"sortId": 99999993,
"diffTableNo": 1,
"isEnabled": {
"value": 1
},
"positionType": {
"name": "未知",
"value": "0"
}
}
],
"rounds": [
{
"status": {
"name": "进行中",
"value": 1
},
"roundId": "4260202088757202945",
"roundName": "第二轮",
"activityId": "4248218677855391745",
"activityName": "活动标题",
"ruleWeight": 0,
"roundNum": 1,
"awardNum": 90,
"sortId": 99999993,
"diffTableNo": 1,
"awardRule": {
"name": "一次抽完",
"value": 1
},
"endDate": {
"name": "2024-01-31 00:00:00",
"value": "2024-01-31T00:00:00"
},
"startDate": {
"name": "2024-01-01 00:00:00",
"value": "2024-01-01T00:00:00"
}
}
],
"activityId": "4248218677855391745",
"activityName": "活动标题",
"subName": "",
"showNum": 26,
"linkObjectId": "",
"linkObjectName": "",
"linkUrl": "",
"videoUrl": "",
"videoRoom": "",
"videoPswd": "",
"appImgUrl": "",
"appBgImgUrl": "",
"webImgUrl": "",
"webBgImgUrl": "",
"activityRule": "iiooiii",
"diffTableNo": 0,
"activityType": {
"name": "新年活动",
"value": "4248218470782603265"
},
"isEnabled": {
"value": 1
},
"isEnter": {
"name": "是",
"value": 1
},
"isSign": {
"name": "是",
"value": 1
},
"routerId": {},
"routerMethod": {
"name": "_self",
"value": "_self"
},
"routerOs": {},
"routerSource": {},
"templateId": {},
"activityEndDate": {
"name": "2024-01-24 00:00:00",
"value": "2024-01-24T00:00:00"
},
"activityStartDate": {
"name": "2024-01-01 02:02:02",
"value": "2024-01-01T02:02:02"
}
},
"currentDay": "2024-01-10",
"cacheDateTimestamp": 0,
"code": "0",
"retCode": "0",
"success": true
}
错误时返回:
{
"code": 0,
"message": ""
"error":{
errorCode:null,
errorText:null
}
"success": false,
}
返回参数说明:
参数名 |
类型 |
说明 |
success |
bool |
true 表示数据请求成功(跟code=0一致),调用者优先使用 |
code |
int |
true 表示数据请求成功(跟code=0一致),调用者优先使用 |
data |
array |
type: sign签到,round轮次,config活动配置,lottery抽奖记录 |
cacheType |
string |
redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化) |
cacheDate |
date |
最后数据获取时间 |
参数名 |
类型 |
说明 |
realName |
string |
真实姓名(如果不存在,使用createUserId) |
文档更新时间: 2024-01-10 00:37 作者:admin