报名页管理

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合法值

说明
0 成功

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. 表单、表格可用组件类型:1:文本输入框组件、2:选择框组件、3:身份证输入组件、4:邮箱组件、5:手机号码组件、6:日期组件、7:时间组件、8:日期时间组件、9:单项组件、10:集体项组件、11:图片上传组件、12:音乐上传组件
  3. 页面功能按钮类型: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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功
40001 提交失败

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功

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合法值

说明
0 成功
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343