| 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 | - |
customerName | string | 客户名称 | true | - |
entryName | string | 项目名称 | true | - |
projectAmount | string | 项目金额 | true | - |
tenderTime | string | 预计投标时间 | true | - |
content | string | 项目基本情况 | false | - |
trade | string | 所属行业 | true | - |
product | string | No comments found. | false | - |
bProduct | array | 产品类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:8888/reporting/informationReporting/add --data '{
"name": "鑫鹏.彭",
"phone": "15727462824",
"wxPhone": "15727462824",
"company": "邵 LLC",
"customerName": "鑫鹏.彭",
"entryName": "鑫鹏.彭",
"projectAmount": "uqfgr2",
"tenderTime": "2023-03-21 18:34:14",
"content": "5d2zdz",
"trade": "m3t13t",
"product": "9ya7ra",
"bProduct": [
"110e15"
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "zhu29q"
}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": 421,
"name": "鑫鹏.彭",
"ids": [
364
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "dseqvl"
}1.3. 关闭项目
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 | - |
itemId | int64 | 项目id | false | - |
Request-example:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/close --data '{
"id": 163,
"name": "鑫鹏.彭",
"itemId": 232
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "f385ch"
}1.4. 项目列表
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 | - |
company | string | 单位名称 | false | - |
trade | string | 所属行业 | false | - |
delStatus | int32 | 删除状态:0删除 1正常 | false | - |
status | int32 | 项目状态:0已关闭 1进行中 | 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?company=邵 LLC&pageSize=10&delStatus=854&order=ruzp3h&status=739&orderField=vcvj90&name=鑫鹏.彭&trade=6eljf1&currPage=1&reportingTime=2023-03-21 18:34:14Response-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": "3635",
"data": {
"totalCount": 553,
"pageSize": 10,
"totalPage": 1,
"currPage": 1,
"list": [
{
"id": 21,
"userName": "鑫鹏.彭",
"name": "鑫鹏.彭",
"password": "mvj26n",
"adminType": 545,
"time": "2023-03-21 18:34:14",
"status": 643
}
]
}
}1.5. 信息导出
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 | - |
company | string | 单位名称 | false | - |
trade | string | 所属行业 | false | - |
status | int32 | 状态:0删除 1进行中 2已关闭 | false | - |
reportingTime | string | 创建时间 | false | - |
Request-example:
curl -X GET -i http://localhost:8888/reporting/informationReporting/download?reportingTime=2023-03-21 18:34:14&name=鑫鹏.彭&trade=2qt2ez&ids=6uxxqz&ids=6uxxqz&status=206&company=邵 LLCResponse-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": "8ra9hq"
}'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": "3635",
"data": {
"id": 630,
"userName": "鑫鹏.彭",
"name": "鑫鹏.彭",
"password": "etyeg9",
"adminType": 922,
"time": "2023-03-21 18:34:14",
"status": 819
}
}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": 685,
"userName": "鑫鹏.彭",
"name": "鑫鹏.彭",
"password": "obcf94"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "sogfni"
}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": [
9
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "9gsdsx"
}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": 794,
"userName": "鑫鹏.彭",
"name": "鑫鹏.彭",
"password": "zavqlu"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "ysf6ow"
}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": 918,
"password": "denvec",
"newPassword": "jybhqp"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "cubuqc"
}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?pageSize=10&orderField=7u8wrx&userName=鑫鹏.彭&currPage=1&time=2023-03-21 18:34:14&order=cy9zpx&name=鑫鹏.彭Response-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": "3635",
"data": {
"totalCount": 446,
"pageSize": 10,
"totalPage": 1,
"currPage": 1,
"list": [
{
"id": 699,
"userName": "鑫鹏.彭",
"name": "鑫鹏.彭",
"password": "i6l4ks",
"adminType": 234,
"time": "2023-03-21 18:34:14",
"status": 941
}
]
}
}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=l0tl66&code=3635Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
success | boolean | 接口调用结果标识 | - |
message | string | 接口调用结果信息 | - |
code | string | 接口调用业务码 | - |
data | object | 接口调用返回数据 | - |
Response-example:
{
"success": true,
"message": "success",
"code": "3635",
"data": "mr2166"
}