VersionUpdate TimeStatusAuthorDescription

0.0.1

2023-03-06 17:25:00

创建文档

浮生

初始化接口文档

1. 

1.1. 获取文件路径链接

Type: POST

Author: 27951

Content-Type: multipart/form-data

Description: 获取文件路径链接

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

No comments found.(array of file)

true

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -i http://localhost:8888/reporting/file/fileUpDown

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "xsou54"
}

2. 报备模块

2.1. 信息上传

Type: POST

Author: 27951

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

Description: 信息上传

Body-parameters:

ParameterTypeDescriptionRequiredSince

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

-

bFile

array

附件材料

false

-

file

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:8888/reporting/informationReporting/add --data '{
  "name": "立果.刘",
  "phone": "17712116610",
  "wxPhone": "17712116610",
  "company": "邹, 林 and 田",
  "customerName": "立果.刘",
  "entryName": "立果.刘",
  "projectAmount": "x3lnsn",
  "tenderTime": "2023-04-18 17:59:10",
  "content": "s2fz8j",
  "trade": "wmzb0r",
  "product": "yh9ugl",
  "bProduct": [
    "z3zb8g"
  ],
  "bFile": [
    "npjd5i"
  ],
  "file": "dzib7z"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "m80aok"
}

2.2. 删除信息

Type: DELETE

Author: 27951

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

Description: 删除信息

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 775,
  "name": "立果.刘",
  "ids": [
    959
  ]
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "oxzid1"
}

2.3. 关闭项目

Type: DELETE

Author: 27951

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

Description: 关闭项目

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 612,
  "name": "立果.刘",
  "itemId": 541
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "waae4i"
}

2.4. 项目列表

Type: GET

Author: 27951

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

Description: 项目列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

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?order=vp3glq&orderField=6myte9&company=邹, 林 and 田&status=801&pageSize=10&name=立果.刘&trade=298v9n&delStatus=207&reportingTime=2023-04-18 17:59:10&currPage=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

-

     └─userName

string

用户名

-

     └─name

string

管理员姓名

-

     └─password

string

密码

-

     └─adminType

int32

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

-

     └─time

string

创建时间

-

     └─status

int32

状态(0停用 1正常)

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": {
    "totalCount": 969,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 679,
        "userName": "立果.刘",
        "name": "立果.刘",
        "password": "9thjje",
        "adminType": 796,
        "time": "2023-04-18 17:59:11",
        "status": 242
      }
    ]
  }
}

2.5. 信息导出

Type: GET

Author: 27951

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

Description: 信息导出

Query-parameters:

ParameterTypeDescriptionRequiredSince

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?status=46&company=邹, 林 and 田&name=立果.刘&trade=l3zytf&ids=uvxll4&ids=uvxll4&reportingTime=2023-04-18 17:59:10

Response-example:

Doesn't return a value.

3. 账户管理模块

3.1. 管理员登录

Type: POST

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

Description: 管理员登录

Body-parameters:

ParameterTypeDescriptionRequiredSince

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

Response-fields:

FieldTypeDescriptionSince

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": "32694",
  "data": {
    "id": 220,
    "userName": "立果.刘",
    "name": "立果.刘",
    "password": "xws8tq",
    "adminType": 396,
    "time": "2023-04-18 17:59:11",
    "status": 481
  }
}

3.2. 添加管理员

Type: POST

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

Description: 添加管理员

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 311,
  "userName": "立果.刘",
  "name": "立果.刘",
  "password": "xs6bqf"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "e47hi2"
}

3.3. 删除管理员

Type: DELETE

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

Description: 删除管理员

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

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

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "6kfcxt"
}

3.4. 修改管理员信息

Type: PUT

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

Description: 修改管理员信息

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 21,
  "userName": "立果.刘",
  "name": "立果.刘",
  "password": "fc22is"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "0ua14i"
}

3.5. 修改本人密码

Type: PUT

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

Description: 修改本人密码

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 29,
  "password": "v9e5yr",
  "newPassword": "s1s2ke"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "jp0ls5"
}

3.6. 管理员列表

Type: GET

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

Description: 管理员列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

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&userName=立果.刘&currPage=1&name=立果.刘&time=2023-04-18 17:59:10&orderField=og5ck9&order=zlwley

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

用户名

-

     └─name

string

管理员姓名

-

     └─password

string

密码

-

     └─adminType

int32

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

-

     └─time

string

创建时间

-

     └─status

int32

状态(0停用 1正常)

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": {
    "totalCount": 800,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 365,
        "userName": "立果.刘",
        "name": "立果.刘",
        "password": "1d57ij",
        "adminType": 279,
        "time": "2023-04-18 17:59:11",
        "status": 870
      }
    ]
  }
}

4. 获取微信绑定手机号

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

Type: GET

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

Description: 通过code换取用户手机号

Query-parameters:

ParameterTypeDescriptionRequiredSince

code

string

No comments found.

false

-

state

string

No comments found.

false

-

Request-example:

curl -X GET -i http://localhost:8888/reporting/wx/getPhone?code=32694&state=ut3nhe

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "32694",
  "data": "ymc6td"
}