1. 获取单个报名页面信息
请求地址
GET /api/v2/pages/:pageId
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
payload |
object |
返回数据 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
payload结构
属性 |
类型 |
说明 |
pageId |
string |
页面ID |
pageTitle |
string |
页面标题 |
containers |
array |
容器(表单、表格) |
containerId |
string |
容器ID |
type |
enum |
容器类型(1:表单、2:表格) |
tableButtons |
array(注1) |
表格功能按钮,表单容器不适用 |
createALine |
boolean |
新增一行 |
deleteLines |
boolean |
删除选中行 |
copyALine |
boolean |
拷贝选中行内容覆盖选中行后面的所有行内容 |
disable |
boolean |
容器级别所有组件是否不可用,默认值:false |
cols |
array |
列数据,表单看成单列 |
colId |
string |
列ID |
label |
string |
列标题,表单相当于组件标签 |
headerAlign |
string(有效值:left、center、right) |
表头对齐方式,默认值:left,表单容器不适用 |
align |
string(有效值:left、center、right) |
列对齐方式,默认值:left,表单容器不适用 |
width |
number |
列宽度,单位:px,表单容器不适用 |
disable |
boolean |
列级别所有组件是否不可用,默认值:false |
component |
object |
列组件 |
type |
enum(注2) |
表单项组件、单元格组件 |
property |
object |
组件属性 |
tooltip |
array |
提示信息 |
minLength |
number |
最小长度限制,输入型组件有效 |
maxLength |
number |
最大长度限制,输入型组件有效 |
options |
array |
选项,选择框组件有效 |
label |
string |
选项标题 |
value |
string |
选项值 |
suggestions |
array |
提示项,单项组件和集体项组件有效 |
imageType |
array |
支持上传的图片格式 |
musicType |
array |
支持上传的音乐格式 |
rows |
array |
行数据 |
rowId |
string |
行ID |
COL_ID_1 |
object |
行中对应的列的列ID |
disable |
boolean |
单元格级别组件是否不可用,默认值:false |
value |
string |
表单项内容、单元格内容 |
align |
string(有效值:left、center、right) |
单元格对齐方式,默认值:left,表单容器不适用 |
buttons |
array |
页面功能按钮 |
label |
string |
按钮标题 |
type |
enum(注3) |
按钮功能类型 |
备注:
- 表格功能按钮描述:新增一行、拷贝选中行内容覆盖选中行后面的所有行内容、删除选中行
- 表单、表格可用组件类型:1:文本输入框组件、2:选择框组件、3:身份证输入组件、4:邮箱组件、5:手机号码组件、6:日期组件、7:时间组件、8:日期时间组件、9:单项组件、10:集体项组件、11:图片上传组件、12:音乐上传组件
- 页面功能按钮类型:1:上一页、2:下一页、3:提交(撤销提交)、4:打印、5:支付
payload结构例子
[{
"pageId": "PAGE_ID",
"pageTitle": "PAGE_TITLE",
"containers": [{
"containerId": "CONTAINER_ID",
"type": "CONTAINER_TYPE",
"tableButtons": {
"createALine": true,
"deleteLines": true,
"copyALine": true
},
"disable": false,
"cols": [{
"colId": "COL_ID",
"label": "LABEL",
"headerAlign": "HEADER_ALIGN",
"align": "COLUMN_ALIGN",
"width": 100,
"disable": false,
"component": {
"type": "COMPONENT_TYPE",
"property": {
"tooltip": ["TOOLTIP"],
"minLength": 1,
"maxLength": 10,
"options": [{
"label": "LABEL",
"value": "VALUE",
}],
"suggestions": ["VALUE"],
"imageType": ["IMAGE_TYPE"],
"musicType": ["MUSIC_TYPE"]
}
}
}],
"rows": [{
"rowId": "ROW_ID",
"COL_ID_1": {
"disable": false,
"value": "VALUE",
"align": "CELL_ALIGN"
},
"COL_ID_2": {
"disable": false,
"value": "VALUE",
"align": "CELL_ALIGN"
}
}]
}],
"buttons": [{
"label": "BUTTON_LABEL",
"type": 1,
}]
}]
2. 保存页面编辑信息
请求地址
POST /api/v2/pages/:pageId/save/text
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
containerId |
string |
|
是 |
容器ID |
rowId |
string |
|
是 |
行ID |
colId |
string |
|
是 |
列ID |
value |
string |
|
是 |
保存的值 |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
3. 获取打印信息
请求地址
GET /api/v2/pages/:pageId/print
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
payload |
object |
返回数据 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
payload结构
属性 |
类型 |
说明 |
print |
string |
打印页内容,html格式 |
payload结构例子
{
"print": "PRINT_CONTENT_HTML"
}
4. 提交报名信息
请求地址
POST /api/v2/pages/:pageId/submit
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
5. 获取支付信息
请求地址
GET /api/v2/pages/:pageId/pay
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
payload |
object |
返回数据 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
payload结构
属性 |
类型 |
说明 |
pay |
string |
支付页内容,html格式 |
payload结构例子
{
"pay": "PAY_CONTENT_HTML"
}
6. 上传图片
请求地址
POST /api/v2/pages/:pageId/images
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
payload |
object |
返回数据 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
payload结构
属性 |
类型 |
说明 |
imageId |
string |
图片ID |
payload结构例子
{
"imageId": "IMAGE_ID"
}
7. 删除上传的图片
请求地址
DELETE /api/v2/pages/:pageId/images/:imageId
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
imageId |
string |
|
是 |
图片ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
8. 获取图片原图
请求地址
GET /api/v2/pages/:pageId/images/:imageId/p
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
imageId |
string |
|
是 |
图片ID |
返回值(状态码:200)
返回图片字节流(bytes)
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
9. 获取图片缩略图
请求地址
GET /api/v2/pages/:pageId/images/:imageId/t
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
imageId |
string |
|
是 |
图片ID |
返回值(状态码:200)
返回图片字节流(bytes)
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
10. 上传音乐
请求地址
POST /api/v2/pages/:pageId/music
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
payload |
object |
返回数据 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
payload结构
属性 |
类型 |
说明 |
musicId |
string |
音乐ID |
payload结构例子
{
"musicId": "MUSIC_ID"
}
11. 删除上传的音乐
请求地址
DELETE /api/v2/pages/:pageId/music/:musicId
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
musicId |
string |
|
是 |
音乐ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
12. 获取音乐
请求地址
GET /api/v2/pages/:pageId/music/:musicId
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
musicId |
string |
|
是 |
音乐ID |
返回值(状态码:200)
返回音乐字节流(bytes)
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
13. 表格功能,新增一行
请求地址
POST /api/v2/pages/:pageId/tables/:containerId/createALine
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
containerId |
string |
|
是 |
容器ID |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
payload |
object |
返回数据 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
payload结构
属性 |
类型 |
说明 |
rowId |
string |
新增行的行ID |
COL_ID_1 |
object |
行中对应的列的列ID |
disable |
boolean |
单元格级别组件是否不可用,默认值:false |
value |
string |
表单项内容、单元格内容 |
align |
string(有效值:left、center、right) |
单元格对齐方式,默认值:left,表单容器不适用 |
payload结构例子
{
"rowId": "ROW_ID",
"COL_ID_1": {
"disable": false,
"value": "VALUE",
"align": "CELL_ALIGN"
},
"COL_ID_2": {
"disable": false,
"value": "VALUE",
"align": "CELL_ALIGN"
}
}
14. 表格功能,删除指定行
请求地址
DELETE /api/v2/pages/:pageId/tables/:containerId/deleteLines?rowIds=ROW_IDS
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
containerId |
string |
|
是 |
容器ID |
rowIds |
string |
|
是 |
被删除行的行ID,逗号分割 |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值
15. 表格功能,拷贝选中行内容覆盖选中行后面的所有行内容
请求地址
PUT /api/v2/pages/:pageId/tables/:containerId/copyALine
请求头参数
属性 |
类型 |
默认值 |
必填 |
说明 |
Authorization |
string |
|
是 |
bearer_token |
请求参数
属性 |
类型 |
默认值 |
必填 |
说明 |
pageId |
string |
|
是 |
报项页面ID |
containerId |
string |
|
是 |
容器ID |
sourceRowId |
string |
|
是 |
拷贝源行的行ID |
targetRowIds |
string |
|
是 |
拷贝目标行的行ID,逗号分割 |
返回值(状态码:200)
返回的JSON数据包(Object)
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
异常
属性 |
类型 |
说明 |
errNo |
number |
错误码 |
errMsg |
array |
错误信息 |
error_code合法值