活动管理
活动列表: /activitys GET
请求参数
参数名 |
示列值 |
类型 |
必须 |
说明 |
默认值 |
page |
1 |
number |
否 |
当前页数 |
1 |
pageSize |
10 |
number |
否 |
每页条数 |
10 |
submitStatus |
1 |
number |
否 |
提交状态:(0:未提交,1:已提交) |
|
name |
活动名称 |
string |
否 |
活动名称 |
|
creatorId |
123 |
number |
否 |
创建人id(organizationId为0时不传) |
|
organizationId |
1 |
number |
否 |
组织id |
|
memberTags |
"1,2,3" |
string |
否 |
患者标签id 多个用逗号隔开 |
|
startStatus |
1 |
number |
否 |
开始状态:(1:未开始,2:进行中,3:已结束) |
|
sort |
-submitAt |
string |
否 |
排序。多个排序字段用,号隔开。sort=-a,b |
|
expand |
'program' |
string |
否 |
获取指定子资源数据: 'program,organization, creator' |
|
attributes |
["id", "name"] |
array |
否 |
本资源的字段。不定义该字段时返回所有字段;空数组不返回字段 |
|
返回参数
参数名 |
示列值 |
说明 |
page |
1 |
当前页数 |
pageSize |
10 |
每页条数 |
limit |
10 |
同 pageSize |
offset |
2 |
起始条数 |
total |
3231 |
符合条件的总数量 |
items |
[{},{}] |
返回数据项(具体字段看活动信息) |
参数名 |
示列值 |
说明 |
id |
1 |
id |
name |
demo |
活动名称 |
organizationId |
3 |
机构id |
creatorId |
1 |
创建者id |
programId |
1 |
关联方案id |
synopsis |
xxxx |
活动介绍 |
abstract |
xxxx |
摘要 |
buttonText |
xxxx |
介绍页按钮文案 |
useGuide |
xxxx |
使用指引 |
interfaceStyle |
0 |
界面样式:(0:无,1,2,3) |
memberSum |
0 |
参与用户人数 |
inventory |
0 |
剩余库存 |
submitStatus |
1 |
提交状态:(0:未提交,1:已提交) |
status |
1 |
状态:(0:禁用,1:启用) |
startStatus |
1 |
开始状态:(1:未开始,2:进行中,3:已结束) |
startAt |
1650160322 |
开始时间 |
endAt |
1650160322 |
结束时间 |
createdAt |
1650160322 |
创建时间 |
updatedAt |
1650160322 |
更新时间 |
program |
{} |
该活动关联的方案内容(具体字段看方案信息) |
organization |
{} |
机构信息(具体字段看机构信息) |
creator |
{} |
创建人信息(具体字段看创建人信息) |
参数名 |
示列值 |
说明 |
id |
1 |
id |
name |
方案名称 |
方案名称 |
参数名 |
示列值 |
说明 |
id |
1 |
id |
name |
机构名称 |
机构名称 |
参数名 |
示列值 |
说明 |
id |
1 |
id |
name |
创建人 |
创建人 |
返回示列
HTTP/1.1 200 OK
{
"items": [
{
"createdAt": 1678514145,
"updatedAt": 1678514145,
"id": 2,
"organizationId": 3,
"creatorId": 5,
"programId": 3,
"name": "dddddd",
"synopsis": "dddddd",
"abstract": null,
"buttonText": "buttonText",
"useGuide": "useGuide",
"interfaceStyle": 0,
"memberSum": 0,
"inventory": 100,
"startAt": 1678351284,
"endAt": 1678381284,
"submitStatus": 1,
"status": 1,
"deletedAt": null,
"startStatus": 3,
"program": {
"id": 3,
"name": "方案名"
},
"organization": {
"id": 3,
"name": "华北医院"
},
"creator": {
"id": 5,
"name": "张三"
}
}
],
"limit": 10,
"offset": 0,
"page": 1,
"pageSize": 10,
"total": 1
}
所有活动: /listAll/activitys GET
请求参数
参数名 |
示列值 |
类型 |
必须 |
说明 |
默认值 |
submitStatus |
1 |
number |
否 |
提交状态:(0:未提交,1:已提交) |
|
name |
活动名称 |
string |
否 |
活动名称 |
|
creatorId |
123 |
number |
否 |
创建人id(organizationId为0时不传) |
|
organizationId |
1 |
number |
否 |
组织id |
|
memberTags |
"1,2,3" |
string |
否 |
患者标签id 多个用逗号隔开 |
|
startStatus |
1 |
number |
否 |
开始状态:(1:未开始,2:进行中,3:已结束) |
|
sort |
-submitAt |
string |
否 |
排序。多个排序字段用,号隔开。sort=-a,b |
|
expand |
'program' |
string |
否 |
获取指定子资源数据: 'program,organization, creator' |
|
attributes |
["id", "name"] |
array |
否 |
本资源的字段。不定义该字段时返回所有字段;空数组不返回字段 |
|
返回示列
HTTP/1.1 200 OK
[
{
"createdAt": 1678514145,
"updatedAt": 1678514145,
"id": 2,
"organizationId": 3,
"creatorId": 5,
"programId": 3,
"name": "dddddd",
"synopsis": "dddddd",
"abstract": null,
"buttonText": "buttonText",
"useGuide": "useGuide",
"interfaceStyle": 0,
"memberSum": 0,
"inventory": 100,
"startAt": 1678351284,
"endAt": 1678381284,
"submitStatus": 1,
"status": 1,
"deletedAt": null,
"program": {
"id": 3,
"name": "111"
},
"organization": {
"id": 3,
"name": "华北医院"
},
"creator": {
"id": 5,
"name": "张三"
},
"startStatus": 3
}
]
活动详情: /activitys/:id GET
请求参数
参数名 |
示列值 |
类型 |
必须 |
说明 |
默认值 |
id |
1 |
number |
是 |
id |
|
expand |
'program' |
string |
否 |
获取指定子资源数据: 'program,organization, creator' |
|
attributes |
["id", "name"] |
array |
否 |
本资源的字段。不定义该字段时返回所有字段;空数组不返回字段 |
|
返回结果: 活动信息