[关闭]
@sewise-dev 2019-08-20T06:08:08.000000Z 字数 5223 阅读 429

华辰考研接口文档(1.2) -- 报名

华辰

更新历史

编号 版本 说明 作者 日期
1 v1.0 1.创建文档 Seven 2019-08-14

目录

【备注】

1. 全局返回码说明

每次调用接口时，可能获得正确或错误的返回码，开发者可以根据返回码信息调试接口，排查错误。

返回码 说明
-1 系统繁忙，此时请开发者稍候再试
200 请求成功
403 禁止访问
404 异常错误
500 数据验证错误
40001 不合法的凭证，或者access_token无效。
40004 不合法请求

HTTP请求状态返回格式

返回字段 字段类型 说明
status Integer 请求返回码(详细请见状态表)
message String 返回描述
data Array 返回结果

错误样例
{
"status": 40013,
"message": {"0":"invalid appid"}
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}

1.管理后台

1.1 班次管理

1.1.1 添加班次

接口地址

/v1/shifts/save

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 Long 用户鉴权码
title 是 String 名称
price 是 Double 价格
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Response
{
"status": 200,
"data": {
"id": "1",
"title": "管理类全科全程.面授（含基础）",
"price": "12800",
"creationDate": "2019-08-14 15:06:59"
}
}

1.1.2 编辑班次

接口地址

/v1/shifts/edit/{id}

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 Long 用户鉴权码
title 是 String 名称
price 是 Double 价格
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Response
{
"status": 200,
"data": {
"id": "1",
"title": "管理类全科全程.面授（含基础）",
"price": "12800",
"creationDate": "2019-08-14 15:06:59"
}
}

1.1.3 删除班次

接口地址

/v1/shifts/remove/{id}

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 Long 用户鉴权码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Response
{
"status": 200,
"message": “删除成功”
}

1.1.4 班次列表

接口地址

/v1/shifts/list

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 Long 用户鉴权码
q 否 String 搜索关键字
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Response
{
"status": 200,
"data": {
"total_page": 1,
"page": 1,
"pagesize": 20,
"total_record": 2,
"record": [
{
"id": "3",
"title": "管理类全科全程精品班.面授（不含基础）",
"price": "11800.00",
"creationDate": "2019-08-14 15:23:38"
},
{
"id": "2",
"title": "管理类全科全程.面授（含基础）",
"price": "12800.00",
"creationDate": "2019-08-14 15:23:11"
}
]
}
}

1.2 报名管理

1.2.1 报名列表

接口地址

/v1/enroll/list

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 Long 用户鉴权码
q 否 String 搜索关键字
enroll 否 Integer 搜索班次id
startDate 否 String 开始时间
endDate 否 String 结束时间
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Response
{
"status": 200,
"data": {
"total_page": 1,
"page": 1,
"pagesize": 20,
"total_record": 2,
"record": [
{
"id": "2",
"name": "魅小舞",
"sex": "女",
"phone": "19999999999",
"address": "广东省广州市天河区",
"email": "nb888@qq.com",
"colleges": "普林斯顿大学",
"specialty": "工商管理",
"enroll": [
{
"title": "管理类全科全程.面授（含基础）",
"price": "12800.00"
}
],
"source": "朋友推荐",
"creationDate": "2019-08-14 16:17:47"
},
{
"id": "1",
"name": "张三",
"sex": "男",
"phone": "18888888888",
"address": "广东省深圳市南山区科技园",
"email": "nb999@qq.com",
"colleges": "哈佛大学",
"specialty": "国际商务",
"enroll": [
{
"title": "管理类全科全程.面授（含基础）",
"price": "12800.00"
},
{
"title": "管理类全科全程精品班.面授（不含基础）",
"price": "11800.00"
}
],
"source": "广告推广",
"creationDate": "2019-08-14 16:15:19"
}
]
}
}

2.前台页面

2.1 报名

2.1.1 报考课程清单

接口地址

/v1/shifts/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Response
{
"status": 200,
"data": [
{
"id": "3",
"title": "管理类全科全程精品班.面授（不含基础）",
"price": "11800.00"
},
{
"id": "2",
"title": "管理类全科全程.面授（含基础）",
"price": "12800.00"
}
]
}

2.1.1 提交报名信息

接口地址

/v1/enroll/signUp

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
name 是 String 姓名
sex 是 Integer 性别：1.男 0.女
phone 是 String 联系方式
address 是 String 联系地址
email 是 String 电子邮箱
colleges 是 String 拟报考院校
specialty 是 String 拟报考专业
enroll 是 String 报考课程（传入id，多个用“,”隔开）
source 是 Integer 报名来源：1.朋友推荐 2.广告推广 3.上门推荐
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Response
{
"status": 200,
"message": "报名成功"
}

2.2 用户

2.2.1 发送短信验证码

接口地址

/v1/sms/send

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数
参数 必选 类型 说明
RequestBody
mobile 是 int 手机号码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d http://web.higoee.com/v1/sms/send
Response
{"status":200,"message":"\u53d1\u9001\u6210\u529f","data":{"mobile":"18675577003"}}

2.2.2 手机短信注册、登录（微信登录）

接口地址

/v1/user/mobileAuth

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
mobile 是 int 手机号码
code 是 int 短信验证码
openid 否 string 微信唯一标识:openid
avatar 否 string 微信头像
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d http://web.higoee.com/v1/user/mobileAuth
Response
{"status":200,"data":{"userId":"5","userType":1,"access_token":"kavjvOPverWrdH8WNbZCjkJZuQ6HbVkEU7Fh4Fxh","expire":"2018-11-12 20:37:52","userinfo":{"userId":"5","username":"18675577003","mobile":"18675577003","code":86028000000005,"userType":1,"roleType":1,"vip":null,"accountStatus":1,"expertRank":0,"lastLogin":"2018-10-13 20:37:52","isDelete":"N","from":null,"promoterUserId":"4","superPromoterUserId":"3","expireDate":null,"creationDate":"2018-10-13 20:37:52","access_token":"kavjvOPverWrdH8WNbZCjkJZuQ6HbVkEU7Fh4Fxh"}}}

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注