H3C报备

Version	Update Time	Status	Author	Description
0.0.1	2023-03-06 17:25:00	创建文档	浮生	初始化接口文档

Version

Update Time

Status

Author

Description

0.0.1

2023-03-06 17:25:00

创建文档

浮生

初始化接口文档

1. 报备模块

1.1. 信息上传

URL: http://localhost:8888/reporting/informationReporting/add

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	-

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": "14753759291",
  "wxPhone": "14753759291",
  "company": "顾-夏",
  "content": "hsuklz"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": "iurimm"
}

1.2. 删除信息

URL: http://localhost:8888/reporting/informationReporting/delete

Type: DELETE

Author: 27951

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

Description: 删除信息

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	null	true	-

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	-

Parameter

Type

Description

Required

Since

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": 753,
  "name": "晓啸.严",
  "ids": [
    514
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": "ey19p2"
}

1.3. 项目列表

URL: http://localhost:8888/reporting/informationReporting/list

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	-

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	-

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?orderField=l74kkx&currPage=1&phone=14753759291&order=yyi453&name=晓啸.严&company=顾-夏&reportingTime=2023-03-15 14:34:48&pageSize=10

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正常）	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─userName

string

用户名

└─name

string

管理员姓名

└─password

string

密码

└─adminType

int32

角色类别 1超级管理员、2管理员

└─time

string

创建时间

└─status

int32

状态（0停用 1正常）

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": {
    "totalCount": 416,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 12,
        "userName": "晓啸.严",
        "name": "晓啸.严",
        "password": "aqnoju",
        "adminType": 697,
        "time": "2023-03-15 14:34:48",
        "status": 819
      }
    ]
  }
}

1.4. 信息导出

URL: http://localhost:8888/reporting/informationReporting/download

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	-

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?ids=pjwu2g&ids=pjwu2g&reportingTime=2023-03-15 14:34:48&phone=14753759291&name=晓啸.严&company=顾-夏

Response-example:

Doesn't return a value.

2. 账户管理模块

2.1. 管理员登录

URL: http://localhost:8888/reporting/user/login

Type: POST

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

Description: 管理员登录

Body-parameters:

Parameter	Type	Description	Required	Since
userName	string	用户名	true	-
password	string	密码	true	-

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": "r2hviq"
}'

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正常）	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─userName

string

用户名

└─name

string

管理员姓名

└─password

string

密码

└─adminType

int32

角色类别 1超级管理员、2管理员

└─time

string

创建时间

└─status

int32

状态（0停用 1正常）

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": {
    "id": 458,
    "userName": "晓啸.严",
    "name": "晓啸.严",
    "password": "4dz5bc",
    "adminType": 556,
    "time": "2023-03-15 14:34:48",
    "status": 513
  }
}

2.2. 添加管理员

URL: http://localhost:8888/reporting/user/add

Type: POST

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

Description: 添加管理员

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	null	true	-

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	密码	true	-

Parameter

Type

Description

Required

Since

int64

false

userName

string

用户名

true

name

string

管理员姓名

true

password

string

密码

true

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": 675,
  "userName": "晓啸.严",
  "name": "晓啸.严",
  "password": "3gnqoy"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": "aqbahy"
}

2.3. 删除管理员

URL: http://localhost:8888/reporting/user/delete

Type: DELETE

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

Description: 删除管理员

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	null	true	-

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter	Type	Description	Required	Since
ids	array	id数组	false	-

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": [
    374
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": "h4rjxn"
}

2.4. 修改管理员信息

URL: http://localhost:8888/reporting/user/update

Type: PUT

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

Description: 修改管理员信息

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	null	true	-

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	密码	true	-

Parameter

Type

Description

Required

Since

int64

false

userName

string

用户名

true

name

string

管理员姓名

true

password

string

密码

true

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": 230,
  "userName": "晓啸.严",
  "name": "晓啸.严",
  "password": "wai0em"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": "sdtlai"
}

2.5. 修改本人密码

URL: http://localhost:8888/reporting/user/updatePassword

Type: PUT

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

Description: 修改本人密码

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	null	true	-

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	-

Parameter

Type

Description

Required

Since

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": 697,
  "password": "5v9oot",
  "newPassword": "9aqggb"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": "9ieal4"
}

2.6. 管理员列表

URL: http://localhost:8888/reporting/user/list

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	-

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	-

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?time=2023-03-15 14:34:48&pageSize=10&userName=晓啸.严&name=晓啸.严&orderField=ax39ot&currPage=1&order=iq4adq

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正常）	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─userName

string

用户名

└─name

string

管理员姓名

└─password

string

密码

└─adminType

int32

角色类别 1超级管理员、2管理员

└─time

string

创建时间

└─status

int32

状态（0停用 1正常）

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": {
    "totalCount": 399,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 339,
        "userName": "晓啸.严",
        "name": "晓啸.严",
        "password": "xm31b7",
        "adminType": 576,
        "time": "2023-03-15 14:34:48",
        "status": 145
      }
    ]
  }
}

3. 获取微信绑定手机号

3.1. 通过code换取用户手机号

URL: http://localhost:8888/reporting/wx/getPhone

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	-

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=cfba2k&code=28686

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "28686",
  "data": "ml3zt6"
}