| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
0.0.1 | 2023-03-06 17:25:00 | 创建文档 | 浮生 | 初始化接口文档 |
1. 报备模块
1.1. 信息上传
Type: POST
Author: 27951
Content-Type: application/json; charset=utf-8
Description: 信息上传
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
name | string | 姓名 | true | - |
phone | string | 手机号 | true | - |
wxPhone | string | 微信绑定手机号 | false | - |
company | string | 单位名称 | true | - |
content | string | 事件登记 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:8888/reporting/informationReporting/add --data '{
"name": "文昊.朱",
"phone": "17301607146",
"wxPhone": "17301607146",
"company": "马-周",
"content": "5z4q9e"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": "kk7yxe"
}1.2. 删除信息
Type: DELETE
Author: 27951
Content-Type: application/json; charset=utf-8
Description: 删除信息
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
admin_token | string | null | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 调用者id(管理员 上传信息的人) | false | - |
name | string | 调用者姓名(管理员 上传信息的人) | false | - |
ids | array | id数组 | false | - |
Request-example:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/delete --data '{
"id": 806,
"name": "文昊.朱",
"ids": [
439
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": "zntdp0"
}1.3. 项目列表
Type: GET
Author: 27951
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 项目列表
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
admin_token | string | null | true | - |
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
name | string | 姓名 | false | - |
phone | string | 电话号码 | false | - |
company | string | 单位名称 | false | - |
reportingTime | string | 创建时间 | false | - |
currPage | int32 | 当前页,默认1 | false | - |
pageSize | int32 | 每页大小,默认10 | false | - |
orderField | string | 排序字段,可选择值参考返回结果 | false | - |
order | string | 排序方式,可选值:asc、desc | false | - |
Request-example:
curl -X GET -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/list?pageSize=10&company=马-周&phone=17301607146&name=文昊.朱&order=kub1ru&reportingTime=2023-03-15 18:05:57&currPage=1&orderField=ppl1faResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
└─totalCount | int32 | 总记录数 | - |
└─pageSize | int32 | 每页记录数 | - |
└─totalPage | int32 | 总页数 | - |
└─currPage | int32 | 当前页数 | - |
└─list | array | 列表数据 | - |
└─id | int64 | id | - |
└─userName | string | 用户名 | - |
└─name | string | 管理员姓名 | - |
└─password | string | 密码 | - |
└─adminType | int32 | 角色类别 1超级管理员、2管理员 | - |
└─time | string | 创建时间 | - |
└─status | int32 | 状态(0停用 1正常) | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": {
"totalCount": 848,
"pageSize": 10,
"totalPage": 1,
"currPage": 1,
"list": [
{
"id": 106,
"userName": "文昊.朱",
"name": "文昊.朱",
"password": "7glo00",
"adminType": 398,
"time": "2023-03-15 18:05:57",
"status": 122
}
]
}
}1.4. 信息导出
Type: GET
Author: 27951
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 信息导出
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
ids | array | id数组 | false | - |
name | string | 姓名 | false | - |
phone | string | 电话号码 | false | - |
company | string | 所在公司 | false | - |
reportingTime | string | 创建时间 | false | - |
Request-example:
curl -X GET -i http://localhost:8888/reporting/informationReporting/download?company=马-周&reportingTime=2023-03-15 18:05:57&name=文昊.朱&ids=f7d13f&ids=f7d13f&phone=17301607146Response-example:
Doesn't return a value.2. 账户管理模块
2.1. 管理员登录
Type: POST
Content-Type: application/json; charset=utf-8
Description: 管理员登录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
userName | string | 用户名 | true | - |
password | string | 密码 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:8888/reporting/user/login --data '{
"userName": "文昊.朱",
"password": "zk6p3n"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
└─id | int64 | id | - |
└─userName | string | 用户名 | - |
└─name | string | 管理员姓名 | - |
└─password | string | 密码 | - |
└─adminType | int32 | 角色类别 1超级管理员、2管理员 | - |
└─time | string | 创建时间 | - |
└─status | int32 | 状态(0停用 1正常) | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": {
"id": 378,
"userName": "文昊.朱",
"name": "文昊.朱",
"password": "h7yh4h",
"adminType": 464,
"time": "2023-03-15 18:05:57",
"status": 924
}
}2.2. 添加管理员
Type: POST
Content-Type: application/json; charset=utf-8
Description: 添加管理员
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
admin_token | string | null | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | id | false | - |
userName | string | 用户名 | true | - |
name | string | 管理员姓名 | true | - |
password | string | 密码 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/add --data '{
"id": 922,
"userName": "文昊.朱",
"name": "文昊.朱",
"password": "tsdn2o"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": "d9r8y0"
}2.3. 删除管理员
Type: DELETE
Content-Type: application/json; charset=utf-8
Description: 删除管理员
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
admin_token | string | null | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
ids | array | id数组 | false | - |
Request-example:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/delete --data '{
"ids": [
811
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": "zgzlml"
}2.4. 修改管理员信息
Type: PUT
Content-Type: application/json; charset=utf-8
Description: 修改管理员信息
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
admin_token | string | null | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | id | false | - |
userName | string | 用户名 | true | - |
name | string | 管理员姓名 | true | - |
password | string | 密码 | false | - |
Request-example:
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/update --data '{
"id": 765,
"userName": "文昊.朱",
"name": "文昊.朱",
"password": "51xezy"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": "rt7gbs"
}2.5. 修改本人密码
Type: PUT
Content-Type: application/json; charset=utf-8
Description: 修改本人密码
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
admin_token | string | null | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 当前登录管理员id | true | - |
password | string | 原密码,密码使用公钥加密后传输 | true | - |
newPassword | string | 新密码,密码使用公钥加密后传输 | true | - |
Request-example:
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/updatePassword --data '{
"id": 272,
"password": "gtvqg4",
"newPassword": "v0gd9q"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": "9uxm5y"
}2.6. 管理员列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 管理员列表
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
admin_token | string | null | true | - |
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
userName | string | 用户名 | false | - |
name | string | 管理员姓名 | false | - |
time | string | 创建时间 | false | - |
currPage | int32 | 当前页,默认1 | false | - |
pageSize | int32 | 每页大小,默认10 | false | - |
orderField | string | 排序字段,可选择值参考返回结果 | false | - |
order | string | 排序方式,可选值:asc、desc | false | - |
Request-example:
curl -X GET -H 'admin_token' -i http://localhost:8888/reporting/user/list?userName=文昊.朱&orderField=0zgkfj&pageSize=10&name=文昊.朱&order=qd08li&currPage=1&time=2023-03-15 18:05:57Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
└─totalCount | int32 | 总记录数 | - |
└─pageSize | int32 | 每页记录数 | - |
└─totalPage | int32 | 总页数 | - |
└─currPage | int32 | 当前页数 | - |
└─list | array | 列表数据 | - |
└─id | int64 | id | - |
└─userName | string | 用户名 | - |
└─name | string | 管理员姓名 | - |
└─password | string | 密码 | - |
└─adminType | int32 | 角色类别 1超级管理员、2管理员 | - |
└─time | string | 创建时间 | - |
└─status | int32 | 状态(0停用 1正常) | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": {
"totalCount": 196,
"pageSize": 10,
"totalPage": 1,
"currPage": 1,
"list": [
{
"id": 312,
"userName": "文昊.朱",
"name": "文昊.朱",
"password": "m5onkn",
"adminType": 558,
"time": "2023-03-15 18:05:57",
"status": 565
}
]
}
}3. 获取微信绑定手机号
3.1. 通过code换取用户手机号
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 通过code换取用户手机号
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
code | string | No comments found. | false | - |
state | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://localhost:8888/reporting/wx/getPhone?state=hna7w9&code=23511Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "23511",
"data": "t9fo4y"
}