VersionUpdate TimeStatusAuthorDescription

0.0.1

2021-08-12 18:50:00

创建文档

codingliang

初始化接口文档

0.0.2

2021-08-13 10:15:00

文档更新

codingliang

新增客户端接口文档

0.0.3

2021-08-13 12:43:00

文档更新

codingliang

新增管理端接口文档

0.0.4

2021-08-14 16:43:00

文档更新

codingliang

新增建行支付成功同步跳转地址

0.1.0

2021-08-19 11:33:00

文档更新

codingliang

新增江西农商行支付

0.1.1

2021-08-20 11:24:51

文档更新

codingliang

新增年级支付限制

1. 管理员

1.1. 管理员登录

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 测试管理员账号密码:admin/12345

Query-parameters:

ParameterTypeDescriptionRequiredSince

userName

string

用户名

true

-

password

string

密码

true

-

Request-example:

curl -X POST -i http://192.168.161.230:9999/tuitionpayment/admininfo/login --data 'userName=烨霖.白&password=dw3bd9'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─userName

string

用户名

-

└─token

string

token

-

└─expireTime

int64

token过期时间

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"userName": "烨霖.白",
		"token": "ymy8v6",
		"expireTime": 1629883144118
	}
}

1.2. 管理员列表

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 管理员列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

curPage

int32

当前页

false

-

pageSize

int32

每页大小

false

-

orderField

string

排序字段

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/admininfo/list?curPage=1&pageSize=10&order=0ageo9&orderField=plm83b

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─totalCount

int32

总记录数

-

└─pageSize

int32

每页记录数

-

└─totalPage

int32

总页数

-

└─currPage

int32

当前页数

-

└─list

array

列表数据

-

     └─id

int64

管理员id,新增时不用传

-

     └─userName

string

用户名

-

     └─password

string

登录密码, 新增时不能为空

-

     └─adminType

string

管理员类型 0超级管理员、1其他管理员

-

     └─status

string

管理员状态 0冻结、1正常

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"totalCount": 304,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 741,
				"userName": "烨霖.白",
				"password": "w1npwj",
				"adminType": "eqpanf",
				"status": "3f5x0a"
			}
		]
	}
}

1.3. 新增管理员

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增管理员

Request-headers:

HeaderTypeDescriptionRequiredSince

admin-token

string

管理员token

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

管理员id,新增时不用传

false

-

userName

string

用户名

true

-

password

string

登录密码, 新增时不能为空

false

-

adminType

string

管理员类型 0超级管理员、1其他管理员

true

-

status

string

管理员状态 0冻结、1正常

true

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin-token' -i http://192.168.161.230:9999/tuitionpayment/admininfo/save? --data '{
	"id": 374,
	"userName": "烨霖.白",
	"password": "88m8o8",
	"adminType": "r40cvn",
	"status": "75l9ss"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "eqv4xj"
}

1.4. 修改管理员

Type: PUT

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 修改管理员

Request-headers:

HeaderTypeDescriptionRequiredSince

admin-token

string

管理员token

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

管理员id,新增时不用传

false

-

userName

string

用户名

true

-

password

string

登录密码, 新增时不能为空

false

-

adminType

string

管理员类型 0超级管理员、1其他管理员

true

-

status

string

管理员状态 0冻结、1正常

true

-

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin-token' -i http://192.168.161.230:9999/tuitionpayment/admininfo/update? --data '{
	"id": 598,
	"userName": "烨霖.白",
	"password": "xp8wv8",
	"adminType": "2ntd7e",
	"status": "ezhy6t"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "jgx2b6"
}

1.5. 删除管理员

Type: DELETE

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除管理员

Request-headers:

HeaderTypeDescriptionRequiredSince

admin-token

string

管理员token

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

管理员id

true

-

Request-example:

curl -X DELETE -H 'admin-token' -i http://192.168.161.230:9999/tuitionpayment/admininfo/delete/860

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "3ddh6o"
}

2. 年级可支付限制设置

2.1. 支付限制列表

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 支付限制列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/enablePayLimit/list

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

array

接口调用返回数据

-

└─id

int64

No comments found.

-

└─gradeName

string

年级名称

-

└─grade

string

年级

-

└─enablePay

string

是否可支付 1能、2不能

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": [
		{
			"id": 623,
			"gradeName": "烨霖.白",
			"grade": "f0qasc",
			"enablePay": "bg1bjm"
		}
	]
}

2.2. 支付限制设置

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 支付限制设置

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

settingId

int64

设置id

true

-

enablePay

string

是否能支付 1能、2不能

true

-

Request-example:

curl -X PUT -H 'admin_token' -i http://192.168.161.230:9999/enablePayLimit/setting/457/1qvmq6

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "i2l4v5"
}

3. 反馈信息

3.1. 新增反馈信息

Type: POST

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 新增反馈信息

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录者学号

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

feedbackPersonName

string

反馈者姓名

true

-

feedbackPersonPhone

string

反馈者电话

true

-

feedbackInfo

string

反馈问题,不要超过512个字符

true

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/feedbackmsg/save? --data '{
	"feedbackPersonName": "烨霖.白",
	"feedbackPersonPhone": "17788389895",
	"feedbackInfo": "67es7w"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "snkiul"
}

3.2. 反馈列表【当前用户】

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 反馈列表【当前用户】

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

No comments found.

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

curPage

int32

当前页

false

-

pageSize

int32

每页大小

false

-

orderField

string

排序字段

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/feedbackmsg/listOfCurrentUser?pageSize=10&curPage=1&order=g4ctfn&orderField=uzfdj5

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─totalCount

int32

总记录数

-

└─pageSize

int32

每页记录数

-

└─totalPage

int32

总页数

-

└─currPage

int32

当前页数

-

└─list

array

列表数据

-

     └─id

int64

id

-

     └─feedbackPersonIdentify

string

反馈者身份标识 使用用户的card_number标识

-

     └─feedbackPersonName

string

反馈者姓名

-

     └─feedbackPersonPhone

string

反馈者电话

-

     └─feedbackInfo

string

反馈问题

-

     └─statu

string

反馈状态 1未处理、2已处理

-

     └─publishTime

string

反馈发布时间

-

     └─handleTime

string

反馈处理时间

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"totalCount": 207,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 223,
				"feedbackPersonIdentify": "dlzxag",
				"feedbackPersonName": "烨霖.白",
				"feedbackPersonPhone": "17788389895",
				"feedbackInfo": "6dt3k6",
				"statu": "ifgi4a",
				"publishTime": "2021-08-25 17:19:04",
				"handleTime": "2021-08-25 17:19:04"
			}
		]
	}
}

3.3. 反馈信息删除

Type: DELETE

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 反馈信息删除

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录者学号

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

反馈信息id

true

-

Request-example:

curl -X DELETE -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/feedbackmsg/delete/465

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "5jdh2y"
}

3.4. 反馈列表【管理员】

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 0.1.0新增keyword关键字查询

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

status

string

状态,不传查全部反馈,1查未处理反馈,2查已处理反馈

false

-

keyword

string

关键字,支持根据根据反馈者姓名、电话搜索

false

-

curPage

int32

当前页

false

-

pageSize

int32

每页大小

false

-

orderField

string

排序字段

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/feedbackmsg/list?keyword=ytg6ve&pageSize=10&orderField=meliqr&status=7u4njl&order=60qesq&curPage=1

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─totalCount

int32

总记录数

-

└─pageSize

int32

每页记录数

-

└─totalPage

int32

总页数

-

└─currPage

int32

当前页数

-

└─list

array

列表数据

-

     └─id

int64

id

-

     └─feedbackPersonIdentify

string

反馈者身份标识 使用用户的card_number标识

-

     └─feedbackPersonName

string

反馈者姓名

-

     └─feedbackPersonPhone

string

反馈者电话

-

     └─feedbackInfo

string

反馈问题

-

     └─statu

string

反馈状态 1未处理、2已处理

-

     └─publishTime

string

反馈发布时间

-

     └─handleTime

string

反馈处理时间

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"totalCount": 223,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 408,
				"feedbackPersonIdentify": "21xh77",
				"feedbackPersonName": "烨霖.白",
				"feedbackPersonPhone": "17788389895",
				"feedbackInfo": "jk99yj",
				"statu": "mwtfxs",
				"publishTime": "2021-08-25 17:19:04",
				"handleTime": "2021-08-25 17:19:04"
			}
		]
	}
}

3.5. 反馈详细信息

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 反馈详细信息

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

反馈id

true

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/feedbackmsg/info/896

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─id

int64

id

-

└─feedbackPersonIdentify

string

反馈者身份标识 使用用户的card_number标识

-

└─feedbackPersonName

string

反馈者姓名

-

└─feedbackPersonPhone

string

反馈者电话

-

└─feedbackInfo

string

反馈问题

-

└─statu

string

反馈状态 1未处理、2已处理

-

└─publishTime

string

反馈发布时间

-

└─handleTime

string

反馈处理时间

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"id": 37,
		"feedbackPersonIdentify": "sghz17",
		"feedbackPersonName": "烨霖.白",
		"feedbackPersonPhone": "17788389895",
		"feedbackInfo": "svtb4x",
		"statu": "b5m5fr",
		"publishTime": "2021-08-25 17:19:04",
		"handleTime": "2021-08-25 17:19:04"
	}
}

3.6. 反馈信息处理

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 将反馈信息从未处理状态改变为已处理状态

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

反馈id

true

-

Request-example:

curl -X PUT -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/feedbackmsg/info/171

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "tqy5xd"
}

4. 学生应缴数据

4.1. 根据card_number获取缴费信息

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 根据card_number获取缴费信息

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录用户cardNumber

true

-

Request-example:

curl -X GET -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/payableinfo/payableInfo

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─id

int64

应缴信息id

-

└─studentNo

string

学号

-

└─studentName

string

姓名

-

└─grade

string

年级

-

└─years

string

收费年度

-

└─collegeName

string

学院名称

-

└─majorName

string

专业名称

-

└─className

string

班级名称

-

└─realPayAmount

number

应付金额

-

└─payItemDetail

string

应付详情 格式:教材费:1000\学费:18000\住宿费:1800

-

└─pay

boolean

是否已缴费

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"id": 334,
		"studentNo": "2u06c3",
		"studentName": "烨霖.白",
		"grade": "n9ahv8",
		"years": "o0idet",
		"collegeName": "烨霖.白",
		"majorName": "烨霖.白",
		"className": "烨霖.白",
		"realPayAmount": 254,
		"payItemDetail": "bmvl1y",
		"pay": true
	}
}

4.2. 根据学号和学生姓名获取缴费信息

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 根据学号和学生姓名获取缴费信息

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录用户cardNumber

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

studentNo

string

学号,新生可用身份证号码代替学号

true

-

studentName

string

学生姓名

true

-

Request-example:

curl -X GET -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/payableinfo/payableInfo/bqk5pg/烨霖.白

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─id

int64

应缴信息id

-

└─studentNo

string

学号

-

└─studentName

string

姓名

-

└─grade

string

年级

-

└─years

string

收费年度

-

└─collegeName

string

学院名称

-

└─majorName

string

专业名称

-

└─className

string

班级名称

-

└─realPayAmount

number

应付金额

-

└─payItemDetail

string

应付详情 格式:教材费:1000\学费:18000\住宿费:1800

-

└─pay

boolean

是否已缴费

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"id": 32,
		"studentNo": "2m2hor",
		"studentName": "烨霖.白",
		"grade": "eaxc6t",
		"years": "wk0uz1",
		"collegeName": "烨霖.白",
		"majorName": "烨霖.白",
		"className": "烨霖.白",
		"realPayAmount": 164,
		"payItemDetail": "0hqo1l",
		"pay": true
	}
}

4.3. 学生应缴列表

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 学生应缴列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keyword

string

姓名或学号关键字查询

false

-

curPage

int32

当前页

false

-

pageSize

int32

每页大小

false

-

orderField

string

排序字段

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/payableinfo/list?pageSize=10&orderField=2pn2p9&order=xv8fhm&keyword=6gmalb&curPage=1

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─totalCount

int32

总记录数

-

└─pageSize

int32

每页记录数

-

└─totalPage

int32

总页数

-

└─currPage

int32

当前页数

-

└─list

array

列表数据

-

     └─id

int64

应缴信息id

-

     └─studentNo

string

学号

-

     └─studentName

string

姓名

-

     └─grade

string

年级

-

     └─years

string

收费年度

-

     └─collegeName

string

学院名称

-

     └─majorName

string

专业名称

-

     └─className

string

班级名称

-

     └─realPayAmount

number

应付金额

-

     └─payItemDetail

string

应付详情 格式:教材费:1000\学费:18000\住宿费:1800

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"totalCount": 495,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 610,
				"studentNo": "34iscd",
				"studentName": "烨霖.白",
				"grade": "8d4uoc",
				"years": "vq1g1i",
				"collegeName": "烨霖.白",
				"majorName": "烨霖.白",
				"className": "烨霖.白",
				"realPayAmount": 443,
				"payItemDetail": "5g4uof"
			}
		]
	}
}

4.4. 学生应缴信息删除

Type: DELETE

Author: codingliang

Content-Type: application/json; charset=utf-8

Description: 学生应缴信息删除

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

需要删除记录的id集合,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/payableinfo/delete --data '[
	920,
	637
]'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "814vd9"
}

4.5. excel 导入学生学费相关原始数据

Type: POST

Author: codingliang

Content-Type: multipart/form-data

Description: 导入学生学费相关原始数据
注意:
1.需要提示用户上传的excel文件需要符合规定的格式;
2.上传新文件将会导致所有的旧数据被删除,学费缴纳开始后不建议再上传新数据。

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

文件,文件格式注意需要符合要求

true

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/payableinfo/importByExcel

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "90s528"
}

4.6. 删除缴费信息

Type: DELETE

Author: codingliang

Content-Type: multipart/form-data

Description: 删除缴费信息
注意:
文件需要符合规定的格式
不会删除已经在线缴费的学生。如果有没有删除的学生,会在接口返回没有被删除学生的列表。

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

文件

true

-

Request-example:

curl -X DELETE -H 'Content-Type: multipart/form-data' -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/payableinfo/payableInfo

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─studentNo

string

学号

-

└─studentName

string

姓名

-

└─grade

string

年级

-

└─years

string

收费年度

-

└─collegeName

string

学院名称

-

└─majorName

string

专业名称

-

└─className

string

班级名称

-

└─realPayAmount

number

应付金额

-

└─payItemDetail

string

应付详情 格式:教材费:1000\学费:18000\住宿费:1800

-

└─msg

string

提示信息

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"studentNo": "4dqeky",
		"studentName": "烨霖.白",
		"grade": "jluaix",
		"years": "hgzp15",
		"collegeName": "烨霖.白",
		"majorName": "烨霖.白",
		"className": "烨霖.白",
		"realPayAmount": 67,
		"payItemDetail": "spfa0k",
		"msg": "jxet2d"
	}
}

5. 支付接口

5.1. 【建行】获取拉起微信支付的参数

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 【建行】获取拉起微信支付的参数

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录用户标识

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

orderNo

string

订单号

true

-

openId

string

支付者唯一标识

true

-

Request-example:

curl -X GET -H 'card_number' -i http://192.168.161.230:9999/pay/ccb/getJsApiParam?orderNo=8805nt&openId=49

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─appId

string

发起支付的appid

-

└─timeStamp

string

时间戳

-

└─nonceStr

string

随机串

-

└─package

string

package信息

-

└─signType

string

签名方式

-

└─paySign

string

签名

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"appId": "49",
		"timeStamp": "2021-08-25 17:19:04",
		"nonceStr": "xtkyfa",
		"package": "jk19qk",
		"signType": "z4agbj",
		"paySign": "n95qd4"
	}
}

5.2. 【建行】支付结果异步通知

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 【建行】支付结果异步通知

Request-example:

curl -X POST -i http://192.168.161.230:9999/pay/ccb/notify

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "3b2waz"
}

5.3. 【建行】支付成功回跳页面

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 支付成功后,建行服务器会调用该接口
该接口监听到建行回调后,会以【fontendUrl + pages/paySuccess/paySuccess?orderNo=123】的形式跳回到前端页面
注意:
fontendUrl + pages/paySuccess/paySuccess是前端支付成功之后的页面,需要前端开发人员与后台开发人员协调好

Request-example:

curl -X GET -i http://192.168.161.230:9999/pay/ccb/success

Response-example:

string

5.4. 【农商行】发起支付

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 页面直接跳转链接【https://q.jxnxs.com/newpay?O=&out_no=&amount=&appoint_notify=】发起支付
O:固定传5494ec3310685daa218382619dd20e27
out_no:订单号,下单接口获取
amount:支付金额,单位元,下单接口获取
appoint_notify:异步通知地址,测试地址:http://7n9xr5.natappfree.cc/pay/jxnxs/notify、正式地址:https://jtishfw.ncjti.edu.cn/jiaofei/backendApi/pay/jxnxs/notify/

Request-example:

curl -X GET -i http://192.168.161.230:9999/pay/spec001

Response-example:

string

5.5. 【农商行】支付结果异步通知

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 【农商行】支付结果异步通知

Request-example:

curl -X GET -i http://192.168.161.230:9999/pay/jxnxs/notify

Response-example:

string

5.6. 【农商行】支付成功跳转地址

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 【农商行】支付成功跳转地址

Query-parameters:

ParameterTypeDescriptionRequiredSince

ord_no

string

订单号

true

-

Request-example:

curl -X GET -i http://192.168.161.230:9999/pay/jxnxs/success?ord_no=jhzsz1

Response-example:

string

6. 支付方式设置

6.1. 支付方式列表

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 支付方式列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/payMethodSetting/list

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

array

接口调用返回数据

-

└─id

int64

支付方式id

-

└─payMethodName

string

支付方式名称

-

└─payMethod

string

支付方式 1建行支付、2农商行支付

-

└─currentPay

string

是否为当前支付方式 1是,2否

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": [
		{
			"id": 739,
			"payMethodName": "烨霖.白",
			"payMethod": "q1hqxx",
			"currentPay": "58krxk"
		}
	]
}

6.2. 设置 payMethodId 为当前支付方式

Type: PUT

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 设置 payMethodId 为当前支付方式

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

支付方式id

true

-

Request-example:

curl -X PUT -H 'admin_token' -i http://192.168.161.230:9999/payMethodSetting/882/currentPay

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": "8q5lkr"
}

6.3. 获取当前支付方式

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取当前支付方式

Request-example:

curl -X GET -i http://192.168.161.230:9999/payMethodSetting/currentPay

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─currentPayMethod

string

当前支付方式 1建行支付、2江西农商行支付

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"currentPayMethod": "a20n6p"
	}
}

7. 缴费订单

7.1. 创建支付订单

Type: POST

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 创建支付订单

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录用户cardNumber

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

studentNo

string

缴费用户studentNo

true

-

Request-example:

curl -X POST -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/payorder/dfyb0d/create

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─orderNo

string

订单号

-

└─msg

string

信息

-

└─payMethod

string

支付方式 1建行支付、2农商行支付

0.1.0

└─amount

number

支付金额

0.1.0

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"orderNo": "jjv65t",
		"msg": "1kat0g",
		"payMethod": "i2o4nb",
		"amount": 809
	}
}

7.2. 订单列表【当前用户】

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 订单列表【当前用户】

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录用户cardNumber

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

curPage

int32

当前页

false

-

pageSize

int32

每页大小

false

-

orderField

string

排序字段

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/payorder/currentUserList?curPage=1&order=shxe5i&orderField=es4g25&pageSize=10

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─totalCount

int32

总记录数

-

└─pageSize

int32

每页记录数

-

└─totalPage

int32

总页数

-

└─currPage

int32

当前页数

-

└─list

array

列表数据

-

     └─id

int64

id

-

     └─orderNo

string

订单号

-

     └─payerIdentify

string

付款者id 付款人的card_number

-

     └─payForIdentify

string

学生id 被付款人的card_number

-

     └─studentName

string

学生姓名

-

     └─className

string

学生班级名称

-

     └─orderAmount

number

订单金额

-

     └─status

string

订单状态 1未支付、2支付成功

-

     └─payMethod

string

支付方式 1建行支付、2农商行支付

0.1.0

     └─createTime

string

创建时间

-

     └─finishTime

string

完成时间

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"totalCount": 661,
		"pageSize": 10,
		"totalPage": 1,
		"currPage": 1,
		"list": [
			{
				"id": 862,
				"orderNo": "odiwki",
				"payerIdentify": "idefb9",
				"payForIdentify": "ry86tq",
				"studentName": "烨霖.白",
				"className": "烨霖.白",
				"orderAmount": 383,
				"status": "scl0x8",
				"payMethod": "0ym7k4",
				"createTime": "2021-08-25 17:19:05",
				"finishTime": "2021-08-25 17:19:05"
			}
		]
	}
}

7.3. 查询订单状态【用户端】

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查询订单状态【用户端】

Request-headers:

HeaderTypeDescriptionRequiredSince

card_number

string

当前登录用户cardNumber

true

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

orderNo

string

订单号

true

-

Request-example:

curl -X GET -H 'card_number' -i http://192.168.161.230:9999/tuitionpayment/payorder/9uiook/orderStatu

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─orderNo

string

订单号

-

└─status

string

订单状态 1未支付、2支付成功

-

└─payerId

string

支付者id

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"orderNo": "rdl6tg",
		"status": "q8brpy",
		"payerId": "49"
	}
}

7.4. 订单列表【管理端】

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 0.1.0新增按照支付方式查询

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

payStatus

string

支付状态 不传查所有,1未支付、2支付成功

false

-

payMethod

string

支付方式 不传查所有,1建行支付、2江西农商行支付

false

0.1.0

keyword

string

关键字,支持缴费用户姓名、班级、订单号搜索

false

-

flag

string

查询标志,1查询所有数据、2查询指定月份数据、3查询指定日期数据

false

-

dateStr

string

月份或日期,当flag为2、3时必传,月份格式:yyyy-MM、日期格式:yyyy-MM-dd

false

-

curPage

int32

当前页

false

-

pageSize

int32

每页大小

false

-

orderField

string

排序字段

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/payorder/list?payMethod=e1wjsr&keyword=p2jf3v&dateStr=ndp82c&curPage=1&flag=i33cac&order=ja5gyh&orderField=12tnzf&payStatus=1mehyw&pageSize=10

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─total

number

当前已支付总金额

-

└─recordsNum

int32

当前已支付的数量

-

└─page

object

分页数据

-

     └─totalCount

int32

总记录数

-

     └─pageSize

int32

每页记录数

-

     └─totalPage

int32

总页数

-

     └─currPage

int32

当前页数

-

     └─list

array

列表数据

-

          └─id

int64

id

-

          └─orderNo

string

订单号

-

          └─payerIdentify

string

付款者id 付款人的card_number

-

          └─payForIdentify

string

学生id 被付款人的card_number

-

          └─studentName

string

学生姓名

-

          └─className

string

学生班级名称

-

          └─orderAmount

number

订单金额

-

          └─status

string

订单状态 1未支付、2支付成功

-

          └─payMethod

string

支付方式 1建行支付、2农商行支付

0.1.0

          └─createTime

string

创建时间

-

          └─finishTime

string

完成时间

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"total": 766,
		"recordsNum": 111,
		"page": {
			"totalCount": 283,
			"pageSize": 10,
			"totalPage": 1,
			"currPage": 1,
			"list": [
				{
					"id": 853,
					"orderNo": "gklamr",
					"payerIdentify": "0x7160",
					"payForIdentify": "n3v61o",
					"studentName": "烨霖.白",
					"className": "烨霖.白",
					"orderAmount": 553,
					"status": "6b6kg2",
					"payMethod": "09imhg",
					"createTime": "2021-08-25 17:19:05",
					"finishTime": "2021-08-25 17:19:05"
				}
			]
		}
	}
}

7.5. 查询订单状态【管理端】

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查询订单状态【管理端】

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

orderNo

string

订单号

true

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/payorder/queryOrderStatu?orderNo=vzszg2

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─orderNo

string

订单号

-

└─status

string

订单状态 1未支付、2支付成功

-

└─payerId

string

支付者id

-

Response-example:

{
	"success": true,
	"message": "success",
	"code": "5053",
	"data": {
		"orderNo": "huchkv",
		"status": "srlvqa",
		"payerId": "49"
	}
}

7.6. 下载完成缴费的学生名单

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 0.1.0新增按照支付方式下载字段

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

管理员token

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

flag

string

1下载所有数据、2下载指定月份数据、3下载指定日期数据

true

-

dateStr

string

当flag为2、3时必传,月份格式:yyyy-MM、日期格式:yyyy-MM-dd

false

-

payMethod

string

支付方式 不传下载所有,1建行支付、2江西农商行支付

false

-

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.230:9999/tuitionpayment/payorder/downloadResult?dateStr=ko4wbb&flag=trk78r&payMethod=vy9t12

Response-example:

Doesn't return a value.

8. 

8.1. 

Type: POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 

Request-example:

curl -X POST -i http://192.168.161.230:9999/test/test1

Response-example:

string

9. 微信相关接口

9.1. 微信授权回调地址

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户跳转到微信授权链接上,微信服务器接收用户授权后会携带code回调到该接口上,该接口使用code获取到用户的openId信息。
如果openId获取成功,该接口会以 【fontendUrl + 路由地址 + ?openId=wx123456】 的形式跳回到前端应用页面;
如果openId获取失败,该接口会以 【fontendUrl + /error/?errorMsg=获取用户openId失败】 的形式跳回到前端应用页面。
注意:
fontendUrl + 路由地址:前端项目地址+页面路由地址,用于前端页面接收用户的信息或错误信息,该地址需要前端人员与后台开发人员协调好。

Query-parameters:

ParameterTypeDescriptionRequiredSince

code

string

微信code

false

-

state

string

No comments found.

false

-

Request-example:

curl -X GET -i http://192.168.161.230:9999/wechat/pub/auth?code=5053&state=qaef7i

Response-example:

string

9.2. 微校授权回调地址

Type: GET

Author: codingliang

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户跳转到微校授权链接上,微校服务器接收用户授权后会携带wxcode回调到该接口上,该接口使用wxcode获取到用户的信息。
如果用户信息获取成功,该接口会以 【fontendUrl + /?cardNumber=wx123456&name=测试用户】 的形式跳回到前端应用页面;
如果用户信息获取失败,该接口会以 【fontendUrl + /error/?errorMsg=获取用户信息失败】 的形式跳回到前端应用页面。
注意:
fontendUrl + 路由地址:前端项目地址+页面路由地址,用于前端页面接收用户的信息或错误信息,该地址需要前端人员与后台开发人员协调好。

Query-parameters:

ParameterTypeDescriptionRequiredSince

wxcode

string

微校code

false

-

state

string

透传数据

false

-

Request-example:

curl -X GET -i http://192.168.161.230:9999/wechat/weixiao/auth?wxcode=5053&state=id8wtv

Response-example:

string

10. 错误码列表

Error codeDescription

10000

系统未知异常

10001

参数格式校验失败

10002

body为空

10003

请求方法不支持

10004

数据已存在

10005

数据不存在

10006

无效的token

10007

参数异常

10008

没有操作权限

10009

管理员登录失败

10012

缺少必要的请求头

10013

缴费信息不存在

10014

订单不存在

10015

获取微信jsapi支付参数失败

10016

建行订单状态查询失败

10017

非建行支付订单

10018

农商行订单状态查询失败

10019

缴费年级不存在

10020

文件导入失败

10100

批量操作数据库失败

11. 数据字典

11.1. 支付状态枚举

CodeTypeDescription

2

string

已支付

1

string

未支付

11.2. 反馈信息状态枚举

CodeTypeDescription

2

string

已处理

1

string

未处理

11.3. 支付方式枚举

CodeTypeDescription

1

string

建行支付

2

string

江西农商行支付