cgrddv/obsidian_note

Fork 0

Files

杜鹏飞 71e83861de vault backup: 2025-12-04 09:12:56

2025-12-04 09:12:56 +08:00

752 KiB

Raw Blame History

认证模块接口文档

简介:系统模块接口文档

HOST:xxxx.xxxx.xxxx

联系人:

Version:

接口路径:/auth/v2/api-docs

[TOC]

app-token-controller

appLogin

接口地址:/auth/appLogin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "username": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
form	form	body	true	LoginBody	LoginBody
password			false	string
username			false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

appLogout

接口地址:/auth/appLogout

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

appPhoneLogin

接口地址:/auth/appPhoneLogin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "code": "",
  "userPhone": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
form	form	body	true	PhoneLoginBody	PhoneLoginBody
code	手机验证码		false	string
userPhone	用户手机号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

appRefresh

接口地址:/auth/appRefresh

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

register

接口地址:/auth/appRegister

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "registerWay": "",
  "userImg": "",
  "userName": "",
  "userPhone": "",
  "userPwd": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
customerDto	customerDto	body	true	InsertCustomerDto	InsertCustomerDto
registerWay	注册方式{1：用户名 2：手机号}		false	string
userImg	用户头像		false	string
userName	用户名称，暂用手机号		false	string
userPhone	用户手机号		false	string
userPwd	用户密码		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

tenant-token-controller

接口地址:/auth/tenant/login

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "username": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
form	form	body	true	LoginBody	LoginBody
password			false	string
username			false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

logout

接口地址:/auth/tenant/logout

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

refresh

接口地址:/auth/tenant/refresh

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

register

接口地址:/auth/tenant/register

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "username": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
registerBody	registerBody	body	true	RegisterBody	RegisterBody
password			false	string
username			false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

token-controller

接口地址:/auth/login

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "username": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
form	form	body	true	LoginBody	LoginBody
password			false	string
username			false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

logout

接口地址:/auth/logout

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

refresh

接口地址:/auth/refresh

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

register

接口地址:/auth/register

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "username": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
registerBody	registerBody	body	true	RegisterBody	RegisterBody
password			false	string
username			false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
msg	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

文件处理模块接口文档

简介:

HOST:xxxx.xxxx.xxxx

联系人:

Version:

接口路径:/file/v2/api-docs

[TOC]

file-controller

downLoad

接口地址:/file/base/download

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileName	fileName	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

单个文件上传

接口地址:/file/base/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
file	file	formData	true	file
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«FileUploadResp»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	string
data	FileUploadResp	FileUploadResp
fileName	string
fileUrl	string
originalFilename	string
message	string
success	boolean

响应示例:

{
	"code": "",
	"data": {
		"fileName": "",
		"fileUrl": "",
		"originalFilename": ""
	},
	"message": "",
	"success": true
}

批量文件上传

接口地址:/file/base/uploadBatch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
files	files	formData	true	array	file
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«FileUploadResp»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	string
data	array	FileUploadResp
fileName	string
fileUrl	string
originalFilename	string
message	string
success	boolean

响应示例:

{
	"code": "",
	"data": [
		{
			"fileName": "",
			"fileUrl": "",
			"originalFilename": ""
		}
	],
	"message": "",
	"success": true
}

pre-file-controller

downLoad

接口地址:/file/front/base/download

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileName	fileName	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

单个文件上传

接口地址:/file/front/base/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
file	file	formData	true	file
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«FileUploadResp»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	string
data	FileUploadResp	FileUploadResp
fileName	string
fileUrl	string
originalFilename	string
message	string
success	boolean

响应示例:

{
	"code": "",
	"data": {
		"fileName": "",
		"fileUrl": "",
		"originalFilename": ""
	},
	"message": "",
	"success": true
}

批量文件上传

接口地址:/file/front/base/uploadBatch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
files	files	formData	true	array	file
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«FileUploadResp»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	string
data	array	FileUploadResp
fileName	string
fileUrl	string
originalFilename	string
message	string
success	boolean

响应示例:

{
	"code": "",
	"data": [
		{
			"fileName": "",
			"fileUrl": "",
			"originalFilename": ""
		}
	],
	"message": "",
	"success": true
}

系统模块接口文档

简介:系统模块接口文档

HOST:xxxx.xxxx.xxxx

联系人:

Version:

接口路径:/gym/v2/api-docs

[TOC]

体育馆VIP卡

新增体育馆VIP卡

接口地址:/gym/vip

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "backgroundFileList": {
    "fileId": 0
  },
  "benefitNotice": "",
  "businessTypes": "",
  "buyNotice": "",
  "endNo": 0,
  "fieldIds": "",
  "isRealAuth": "",
  "isSelf": "",
  "issueNum": 0,
  "logoFileList": {
    "fileId": 0
  },
  "realAmout": 0,
  "realNum": 0,
  "salePrice": 0,
  "startNo": 0,
  "useNotice": "",
  "validityTerm": 0,
  "venueIds": "",
  "vipDesc": "",
  "vipId": 0,
  "vipName": "",
  "vipType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymVipAddDto	新增体育馆会员卡表Dto	body	true	GymVipAdd对象	GymVipAdd对象
backgroundFileList	会员卡background文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
benefitNotice	权益说明;（0：否，1：是）		false	string
businessTypes	支持的项目		false	string
buyNotice	购买须知		false	string
endNo	会员卡号结束		false	integer(int64)
fieldIds	支持的场地		false	string
isRealAuth	是否实名制购卡;（0：否，1：是）		false	string
isSelf	是否仅限本人使用;（0：否，1：是）		false	string
issueNum	发卡数量		false	integer(int32)
logoFileList	会员卡LOGO文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
realAmout	会员卡储值金额		false	number
realNum	会员卡储值次数		false	integer(int32)
salePrice	会员卡售价		false	number
startNo	会员卡号起始		false	integer(int64)
useNotice	使用说明		false	string
validityTerm	有效期		false	integer(int32)
venueIds	支持的场馆		false	string
vipDesc	会员卡介绍		false	string
vipId	主键ID		false	integer(int64)
vipName	会员卡名称		false	string
vipType	会员卡类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改体育馆VIP卡

接口地址:/gym/vip

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "backgroundFileList": {
    "fileId": 0
  },
  "benefitNotice": "",
  "businessTypes": "",
  "buyNotice": "",
  "endNo": 0,
  "fieldIds": "",
  "isRealAuth": "",
  "isSelf": "",
  "issueNum": 0,
  "logoFileList": {
    "fileId": 0
  },
  "realAmout": 0,
  "realNum": 0,
  "salePrice": 0,
  "startNo": 0,
  "useNotice": "",
  "validityTerm": 0,
  "venueIds": "",
  "vipDesc": "",
  "vipId": 0,
  "vipName": "",
  "vipType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymVipEditDto	新增体育馆会员卡表Dto	body	true	GymVipAdd对象	GymVipAdd对象
backgroundFileList	会员卡background文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
benefitNotice	权益说明;（0：否，1：是）		false	string
businessTypes	支持的项目		false	string
buyNotice	购买须知		false	string
endNo	会员卡号结束		false	integer(int64)
fieldIds	支持的场地		false	string
isRealAuth	是否实名制购卡;（0：否，1：是）		false	string
isSelf	是否仅限本人使用;（0：否，1：是）		false	string
issueNum	发卡数量		false	integer(int32)
logoFileList	会员卡LOGO文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
realAmout	会员卡储值金额		false	number
realNum	会员卡储值次数		false	integer(int32)
salePrice	会员卡售价		false	number
startNo	会员卡号起始		false	integer(int64)
useNotice	使用说明		false	string
validityTerm	有效期		false	integer(int32)
venueIds	支持的场馆		false	string
vipDesc	会员卡介绍		false	string
vipId	主键ID		false	integer(int64)
vipName	会员卡名称		false	string
vipType	会员卡类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询体育馆VIP卡列表

接口地址:/gym/vip/listByVip

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginSalePrice	会员卡售价起	query	false	number
businessTypes	支持的项目	query	false	string
endSalePrice	会员卡售价末	query	false	number
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
vipId	主键ID	query	false	integer(int64)
vipName	会员卡名称	query	false	string
vipStatus	会员卡状态	query	false	string
vipType	会员卡类型	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

VIP卡上下架

接口地址:/gym/vip/offline/{vipId}/{vipStatus}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
vipId	vipId	path	true	integer(int64)
vipStatus	vipStatus	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询体育馆VIP卡详细信息

接口地址:/gym/vip/{vipId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
vipId	vipId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除体育馆VIP卡

接口地址:/gym/vip/{vipId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
vipId	vipId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

体育馆场地

新增体育馆场地

接口地址:/gym/gymField

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fieldArea": 0,
  "fieldBusiness": "",
  "fieldDesc": "",
  "fieldName": "",
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "venueId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymFieldAddDto	体育馆场地Dto	body	true	GymFieldAddDto对象	GymFieldAddDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fieldArea	场地面积		false	integer(int32)
fieldBusiness	场地经营项目		false	string
fieldDesc	场地描述		false	string
fieldName	场地名称		false	string
fileList	文件List		false	array	新增或修改关联多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：场馆平面图）		true	string
venueId	场馆Id		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改体育馆场地

接口地址:/gym/gymField

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fieldArea": 0,
  "fieldBusiness": "",
  "fieldDesc": "",
  "fieldId": 0,
  "fieldName": "",
  "fieldStatus": "",
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymFieldEditDto	博物馆场地Dto	body	true	GymFieldEditDto对象	GymFieldEditDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fieldArea	场地面积		false	integer(int32)
fieldBusiness	场地经营项目		false	string
fieldDesc	场地描述		false	string
fieldId	主键ID		false	integer(int64)
fieldName	场地名称		false	string
fieldStatus	场地状态;（0：停用，1：开放）		false	string
fileList	文件List		false	array	新增或修改关联多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：场馆平面图）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

场地启用与停用

接口地址:/gym/gymField/fieldStatus

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "fieldId": 0,
  "fieldStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymFieldStatusDto	体育馆场地状态Dto	body	true	GymFieldStatusDto对象	GymFieldStatusDto对象
fieldId	场地主键ID		false	integer(int64)
fieldStatus	场地状态;（0：停用，1：开放）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询体育馆场地列表

接口地址:/gym/gymField/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)
venueId	场馆id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取体育馆场地详细信息

接口地址:/gym/gymField/{fieldId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fieldId	fieldId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除体育馆场地

接口地址:/gym/gymField/{fieldId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fieldId	fieldId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

体育馆场馆

新增体育馆场馆

接口地址:/gym/gymVenue

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "contactName": "",
  "contactTel": "",
  "coverFile": {
    "fileId": 0
  },
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "gymId": 0,
  "venueAddress": "",
  "venueArea": 0,
  "venueDesc": "",
  "venueName": "",
  "venueService": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymVenueAddDto	体育馆场馆Dto	body	true	GymVenueAddDto对象	GymVenueAddDto对象
contactName	联系人		false	string
contactTel	联系方式		false	string
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileList	文件List		false	array	新增或修改关联多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：场馆平面图）		true	string
gymId	体育馆Id		false	integer(int64)
venueAddress	场馆地址		false	string
venueArea	场馆面积		false	integer(int32)
venueDesc	场馆描述		false	string
venueName	场馆名称		false	string
venueService	场馆服务		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改体育馆场馆

接口地址:/gym/gymVenue

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "contactName": "",
  "contactTel": "",
  "coverFile": {
    "fileId": 0
  },
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "venueAddress": "",
  "venueArea": 0,
  "venueDesc": "",
  "venueId": 0,
  "venueName": "",
  "venueService": "",
  "venueStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymVenueEditDto	体育馆场馆Dto	body	true	GymVenueEditDto对象	GymVenueEditDto对象
contactName	联系人		false	string
contactTel	联系方式		false	string
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileList	文件List		false	array	新增或修改关联多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：场馆平面图）		true	string
venueAddress	场馆地址		false	string
venueArea	场馆面积		false	integer(int32)
venueDesc	场馆描述		false	string
venueId	主键ID		false	integer(int64)
venueName	场馆名称		false	string
venueService	场馆服务		false	string
venueStatus	场馆状态;（0：停用，1：开放）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询体育馆场馆列表

接口地址:/gym/gymVenue/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string
endTime	结束时间	query	false	string
gymId	体育馆Id	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
venueStatus	场馆状态	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

场馆启用与停用

接口地址:/gym/gymVenue/venueStatus

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "venueId": 0,
  "venueStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymVenueStatusDto	体育馆场馆Dto	body	true	GymVenueStatusDto对象	GymVenueStatusDto对象
venueId	场馆主键ID		false	integer(int64)
venueStatus	场馆状态;（0：停用，1：开放）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取体育馆场馆详细信息

接口地址:/gym/gymVenue/{venueId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
venueId	venueId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除体育馆场馆

接口地址:/gym/gymVenue/{venueId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
venueId	venueId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

体育馆基础

获取体育馆基础详细信息

接口地址:/gym/gymBase

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

新增体育馆基础

接口地址:/gym/gymBase

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "alipayAccount": "",
  "areaCode": "",
  "cityCode": "",
  "gymAddress": "",
  "gymDesc": "",
  "gymId": 0,
  "gymLogo": "",
  "gymName": "",
  "payChannel": "",
  "phone": "",
  "provinceCode": "",
  "themeColor": "",
  "wechatAppid": "",
  "wechatMchId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymBaseAddDto	体育馆基础Dto	body	true	GymBaseAddDto对象	GymBaseAddDto对象
alipayAccount	支付宝账号		false	string
areaCode	区编码		false	string
cityCode	市编码		false	string
gymAddress	体育馆地址		false	string
gymDesc	体育馆简介		false	string
gymId	主键ID		false	integer(int64)
gymLogo	体育馆LOGO		false	string
gymName	体育馆名称		false	string
payChannel	支付渠道		false	string
phone	手机号		false	string
provinceCode	省编码		false	string
themeColor	主题颜色		false	string
wechatAppid	微信APPID		false	string
wechatMchId	微信商户号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改体育馆基础

接口地址:/gym/gymBase

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "alipayAccount": "",
  "areaCode": "",
  "cityCode": "",
  "gymAddress": "",
  "gymDesc": "",
  "gymId": 0,
  "gymLogo": "",
  "gymName": "",
  "payChannel": "",
  "phone": "",
  "provinceCode": "",
  "themeColor": "",
  "wechatAppid": "",
  "wechatMchId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymBaseEditDto	体育馆基础Dto	body	true	GymBaseAddDto对象	GymBaseAddDto对象
alipayAccount	支付宝账号		false	string
areaCode	区编码		false	string
cityCode	市编码		false	string
gymAddress	体育馆地址		false	string
gymDesc	体育馆简介		false	string
gymId	主键ID		false	integer(int64)
gymLogo	体育馆LOGO		false	string
gymName	体育馆名称		false	string
payChannel	支付渠道		false	string
phone	手机号		false	string
provinceCode	省编码		false	string
themeColor	主题颜色		false	string
wechatAppid	微信APPID		false	string
wechatMchId	微信商户号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取行政区域

接口地址:/gym/gymBase/getAddress

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
parentCode	父地区编码	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询体育馆基础列表

接口地址:/gym/gymBase/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除体育馆基础

接口地址:/gym/gymBase/{gymId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
gymId	gymId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

前台体育馆VIP卡

前台查询体育馆VIP卡列表

接口地址:/gym/front/vip/noLogin/listByVip

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginSalePrice	会员卡售价起	query	false	number
businessTypes	支持的项目	query	false	string
endSalePrice	会员卡售价末	query	false	number
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
vipId	主键ID	query	false	integer(int64)
vipName	会员卡名称	query	false	string
vipStatus	会员卡状态	query	false	string
vipType	会员卡类型	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台查询体育馆VIP卡详细信息

接口地址:/gym/front/vip/noLogin/{vipId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
vipId	vipId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台体育馆场馆

前台获取体育馆场馆详细信息

接口地址:/gym/front/gymVenue/noLogin/venue

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
venueId	venueId	query	true	integer(int64)
businessId	businessId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台收藏

添加收藏

接口地址:/gym/front/dataCollection/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCollectionAddDto	dataCollectionAddDto	body	true	添加收藏Dto	添加收藏Dto
dataId	数据ID		false	integer(int64)
dataType	收藏类型 2:场馆,4:文章		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除收藏

接口地址:/gym/front/dataCollection/del/{dataId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询我的收藏列表

接口地址:/gym/front/dataCollection/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
collectionBy	收藏人	query	false	string
dataName	收藏名称	query	false	string
dataType	收藏类型 2:场馆,4:文章	query	false	string
reqType	请求类型{0：后台，1：前台}	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台文章管理

前台获取用户服务协议和隐私政策（contentType 1：用户服务协议，2：隐私政策）

接口地址:/gym/front/gymArticle/noLogin/getAgreementAndPolicy

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
contentType	contentType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取体育馆展馆概况

接口地址:/gym/front/gymArticle/noLogin/getGymSituation

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台查询文章列表

接口地址:/gym/front/gymArticle/noLogin/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleModule	所属模块（1：新闻动态，2：活动发布	query	false	string
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台获取文章详细信息

接口地址:/gym/front/gymArticle/noLogin/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleId	articleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台点赞

添加点赞

接口地址:/gym/front/dataPraise/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataPraiseAddDto	dataPraiseAddDto	body	true	添加点赞Dto	添加点赞Dto
dataId	数据ID		false	integer(int64)
dataType	点赞类型 2:场馆,4:文章		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除点赞

接口地址:/gym/front/dataPraise/del/{dataId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询我的点赞

接口地址:/gym/front/dataPraise/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	收藏类型 2:场馆,4:文章	query	false	string
praiseBy	点赞人	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台用户VIP使用

前台新增用户VIP使用（类似订单）

接口地址:/gym/front/use

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cardId": 0,
  "cardNo": 0,
  "reserveId": 0,
  "useAmout": 0,
  "useId": 0,
  "useNum": 0,
  "useRemark": "",
  "useStatus": "",
  "userCardNo": "",
  "userCardType": "",
  "userId": 0,
  "userName": "",
  "userNickName": "",
  "userOpenId": "",
  "userPhone": "",
  "userRealName": "",
  "vipEndDate": "",
  "vipId": 0,
  "vipStartDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
cardUseAddDto	新增用户VIP使用表Dto	body	true	CardUseAddDto对象	CardUseAddDto对象
cardId	用户卡ID		false	integer(int64)
cardNo	会员卡卡号		false	integer(int64)
reserveId	预约ID		false	integer(int64)
useAmout	使用金额		false	number
useId	主键ID		false	integer(int64)
useNum	使用次数		false	integer(int32)
useRemark	使用备注		false	string
useStatus	使用状态		false	string
userCardNo	用户身份证号码		false	string
userCardType	用户证件类型		false	string
userId	用户ID		false	integer(int64)
userName	用户名称		false	string
userNickName	用户昵称		false	string
userOpenId	用户微信ID		false	string
userPhone	用户手机号		false	string
userRealName	用户真实姓名		false	string
vipEndDate	VIP有效期截止		false	string(date-time)
vipId	会员卡ID		false	integer(int64)
vipStartDate	VIP有效期起始		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台查询用户VIP使用（类似订单）列表

接口地址:/gym/front/use/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardNo	会员卡卡号	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
useId	会员卡使用Id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取用户VIP已使用金额

接口地址:/gym/front/use/money

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	会员卡ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
useId	主键ID	query	false	integer(int64)
vipId	会员卡ID	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

vip使用退款

接口地址:/gym/front/use/refund/{useId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
useId	useId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取用户VIP使用（类似订单）详细信息

接口地址:/gym/front/use/{useId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
useId	useId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台用户VIP卡

前台新增用户VIP卡

接口地址:/gym/front/card

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cardId": 0,
  "cardNo": 0,
  "reserveId": 0,
  "useNum": 0,
  "userAmout": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
userCardAddDto	修改用户VIP表Dto	body	true	UserCardAddDto	UserCardAddDto
cardId	用户卡Id		false	integer(int64)
cardNo	会员卡卡号		false	integer(int64)
reserveId	预约Id		false	integer(int64)
useNum	会员卡扣除次数		false	integer(int32)
userAmout	会员卡扣除金额		false	number
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台修改用户VIP卡(付钱)

接口地址:/gym/front/card

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cardId": 0,
  "cardNo": 0,
  "reserveId": 0,
  "useNum": 0,
  "userAmout": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
userCardEditDto	修改用户VIP表Dto	body	true	UserCardAddDto	UserCardAddDto
cardId	用户卡Id		false	integer(int64)
cardNo	会员卡卡号		false	integer(int64)
reserveId	预约Id		false	integer(int64)
useNum	会员卡扣除次数		false	integer(int32)
userAmout	会员卡扣除金额		false	number
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台查询可支付VIP卡列表

接口地址:/gym/front/card/listByAnyId

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessType	经营项目类型	query	false	string
fieldId	场地Id	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
venueId	场馆Id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台查询用户VIP卡列表

接口地址:/gym/front/card/listByCard

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	主键Id	query	false	integer(int64)
cardNo	会员卡卡号	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
userId	用户ID	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台查询用户VIP卡适用场馆列表

接口地址:/gym/front/card/listByCardId

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)
vipId	vipId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台查询VIP卡使用记录

接口地址:/gym/front/card/listByCardNo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	主键Id	query	false	integer(int64)
cardNo	会员卡卡号	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
userId	用户ID	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取用户详情

接口地址:/gym/front/card/member/{cardId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	cardId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取用户VIP卡详情

接口地址:/gym/front/card/vip/{cardId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	cardId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取用户VIP卡详细信息

接口地址:/gym/front/card/{cardId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	cardId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台用户VIP购买

前台新增体育场vip购买

接口地址:/gym/front/base

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "orderRemark": "",
  "totalAmout": 0,
  "userCardNo": "",
  "userCardType": "",
  "userPhone": "",
  "userRealName": "",
  "vipId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
vipBaseAddDto	新增用户VIP购买表	body	true	VipBaseAddDto对象	VipBaseAddDto对象
orderRemark	订单备注		false	string
totalAmout	订单金额		false	number
userCardNo	用户身份证号码		false	string
userCardType	用户证件类型		false	string
userPhone	用户手机号		false	string
userRealName	用户真实姓名		false	string
vipId	会员卡名称		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台查询用户VIP购买（订单）列表

接口地址:/gym/front/base/listByOrder

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string(date-time)
endTime	结束时间	query	false	string(date-time)
orderId	主键ID	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
totalAmout	订单金额	query	false	number
vipName	会员卡名称	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

VIP卡订单支付

接口地址:/gym/front/base/toPay

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "beginTime": "",
  "endTime": "",
  "orderId": 0,
  "pageNum": 0,
  "pageSize": 0,
  "totalAmout": 0,
  "vipName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
vipBaseListDto	查询用户VIP购买表	body	true	VipBaseListDto对象	VipBaseListDto对象
beginTime	开始时间		false	string(date-time)
endTime	结束时间		false	string(date-time)
orderId	主键ID		false	integer(int64)
pageNum	分页参数		false	integer(int32)
pageSize	分页参数		false	integer(int32)
totalAmout	订单金额		false	number
vipName	会员卡名称		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取用户VIP购买详细信息

接口地址:/gym/front/base/{orderId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台评论

新增评论

接口地址:/gym/front/dataComment/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "commentContent": "",
  "dataId": 0,
  "dataType": "",
  "venueId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCommentAddDTO	dataCommentAddDTO	body	true	添加评论Dto	添加评论Dto
commentContent	评论内容		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型 8:订单,4:文章		false	string
venueId	场馆ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改评论

接口地址:/gym/front/dataComment/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "commentContent": "",
  "commentId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCommentEditDto	dataCommentEditDto	body	true	修改评论	修改评论
commentContent	评论内容		false	string
commentId	评论ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询我的评论列表

接口地址:/gym/front/dataComment/myList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
commentBy	评论者	query	false	string
commentStatus	评论状态 0初始，1通过，2不通过	query	false	string
databaseAlias	数据库别名	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询文章和订单评论

接口地址:/gym/front/dataComment/noLogin/articleList/{dataId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询场馆评论

接口地址:/gym/front/dataComment/noLogin/venueList/{venueId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
venueId	venueId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台预约场地配置管理

前台查询开放预约的所有经营项目类型

接口地址:/gym/front/gymBusiness/noLogin/businessTypeList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台查询体育馆预约场地配置列表

接口地址:/gym/front/gymBusiness/noLogin/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessType	经营项目类型;（1：足球，2：篮球，3：羽毛球，4：网球，5：乒乓球，6：游泳，7：健身，8：桌球，9：拳击，10：击剑，11：其他）	query	true	string
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台获取可预约日期列表

接口地址:/gym/front/gymBusiness/noLogin/orderDateList/{businessId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessId	businessId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取可预约场地列表

接口地址:/gym/front/gymBusiness/noLogin/orderFieldList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessId	预约场地配置ID	query	false	integer(int64)
date	预约日期	query	false	string(date)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取体育馆预约场地配置详细信息

接口地址:/gym/front/gymBusiness/noLogin/{businessId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessId	businessId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

后台用户VIP使用

后台查询用户VIP使用列表

接口地址:/gym/use/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardNo	会员卡卡号	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
useId	会员卡使用Id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

后台获取用户VIP使用详细信息

接口地址:/gym/use/{useId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
useId	useId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

多媒体文件管理

新增多媒体文件

接口地址:/gym/gymFile

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileDesc": "",
  "fileName": "",
  "fileType": 1,
  "fileUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumFileAddDto	museumFileAddDto	body	true	新增多媒体文件Dto	新增多媒体文件Dto
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileDesc	文件简介		true	string
fileName	文件名称		true	string
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
fileUrl	文件路径（相对）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改多媒体文件

接口地址:/gym/gymFile

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileDesc": "",
  "fileId": 0,
  "fileName": "",
  "fileUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumFileEditDto	museumFileEditDto	body	true	修改多媒体文件Dto	修改多媒体文件Dto
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileDesc	文件简介		false	string
fileId	文件ID		true	integer(int64)
fileName	文件名称		false	string
fileUrl	文件路径（相对）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

判断文件是否已经存在

接口地址:/gym/gymFile/isExist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileName	文件名称	query	true	string
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

判断文件是否被引用

接口地址:/gym/gymFile/isQuote/{fileIds}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileIds	fileIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询多媒体文件列表

接口地址:/gym/gymFile/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	操作开始时间	query	false	string(date)
endTime	操作结束时间	query	false	string(date)
fileName	文件名称	query	false	string
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除多媒体文件

接口地址:/gym/gymFile/{fileIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileIds	fileIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

获取多媒体文件详细信息

接口地址:/gym/gymFile/{fileId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileId	fileId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

推送记录

批量删除推送数据

接口地址:/gym/gymRecord/deletes

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
ids	ids	query	false	array	integer
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取推送数据详情

接口地址:/gym/gymRecord/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
activeStatus		query	false	string
createEnd	注册时间：结束日期(10)	query	false	string
createStart	注册时间：开始日期(10)	query	false	string
dataType	数据类型:2：场馆， 3：场地	query	false	string
databaseAlias	数据库别名	query	false	string
fieldName	场地名称(10)	query	false	string
pushId	pushId	query	false	integer(int64)
pushTag	推送标签	query	false	string
reserveType	预约类型(10)	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userAddress		query	false	string
venueName	场馆名称(10)	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取推送数据记录列表

接口地址:/gym/gymRecord/recordList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	数据类型	query	false	string
pushStatus	推送状态,0:未推送,1:已推送	query	false	string
pushTimeEnd	推送时间止	query	false	string(date-time)
pushTimeStart	推送时间起	query	false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除推送数据

接口地址:/gym/gymRecord/update

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
pushId	pushId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

支付相关

支付信息

接口地址:/gym/front/userPay/getPay/{orderId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

支付结果通知(应为第三方回调接口，接入后修改)

接口地址:/gym/front/userPay/noLogin/payCallBack/{orderId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

退款结果通知(应与支付结果通知统一，需接入后修改)

接口地址:/gym/front/userPay/noLogin/refundCallBack

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
type	type	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

去支付

接口地址:/gym/front/userPay/toPay

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "orderId": 0,
  "orderType": "",
  "payAmout": 0,
  "payChannel": "",
  "payMethod": "",
  "payType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
addDto	addDto	body	true	UserPayAddDto	UserPayAddDto
orderId	订单ID		false	integer(int64)
orderType	订单类型{1:展览预约订单 2：会员卡}		false	string
payAmout	支付金额		false	number
payChannel	支付渠道{ 1：微信 }		false	string
payMethod	支付方式{1:微信}		false	string
payType	支付类型{1:线上购买 2：现场购买}		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询会员收藏列表

接口地址:/gym/dataCollection/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
collectionBy	收藏人	query	false	string
dataName	收藏名称	query	false	string
dataType	收藏类型 2:场馆,4:文章	query	false	string
reqType	请求类型{0：后台，1：前台}	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

数据审核

新增保存数据审核

接口地址:/gym/dataApproval/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approvalStatus": "",
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	新增数据审核Dto	新增数据审核Dto
approvalDesc	审核描述		false	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量新增数据审核(批量审核)

接口地址:/gym/dataApproval/adds

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

[
  {
    "approvalDesc": "",
    "approvalStatus": "",
    "dataId": 0,
    "dataType": ""
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dtos	dtos	body	true	array	新增数据审核Dto
approvalDesc	审核描述		false	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	新增数据审核Dto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
approvalDesc	审核描述	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string
dataId	数据ID	integer(int64)	integer(int64)
dataType	数据类型	string

响应示例:

[
	{
		"approvalDesc": "",
		"approvalStatus": "",
		"dataId": 0,
		"dataType": ""
	}
]

修改保存数据审核

接口地址:/gym/dataApproval/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approvalId": 0,
  "approvalStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	修改数据审核Dto	修改数据审核Dto
approvalDesc	审核描述		false	string
approvalId	审批ID		false	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量修改数据审核(批量审核)

接口地址:/gym/dataApproval/edits

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

[
  {
    "approvalDesc": "",
    "approvalId": 0,
    "approvalStatus": ""
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dtos	dtos	body	true	array	修改数据审核Dto
approvalDesc	审核描述		false	string
approvalId	审批ID		false	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	修改数据审核Dto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
approvalDesc	审核描述	string
approvalId	审批ID	integer(int64)	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string

响应示例:

[
	{
		"approvalDesc": "",
		"approvalId": 0,
		"approvalStatus": ""
	}
]

查询数据审核列表

接口地址:/gym/dataApproval/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
approvalEnd	结束时间：审核时间	query	false	string(date)
approvalStart	开始时间：审核时间	query	false	string(date)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	query	false	string
dataType	数据类型	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PageInfo«数据审核列表Vo»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
endRow		integer(int64)	integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	数据审核列表Vo
approvalBy	审核者	string
approvalDesc	审核描述	string
approvalId	审批ID	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string
approvalTime	审核时间	string(date-time)
dataId	数据ID	string
dataType	数据类型	string
delFlag	删除标识;（0：未删除，1：已删除）	string
isCurr	是否最新审核记录;（0：否，1：是）	string
tenantId	租户ID	string
navigateFirstPage		integer(int32)	integer(int32)
navigateLastPage		integer(int32)	integer(int32)
navigatePages		integer(int32)	integer(int32)
navigatepageNums		array
nextPage		integer(int32)	integer(int32)
pageNum		integer(int32)	integer(int32)
pageSize		integer(int32)	integer(int32)
pages		integer(int32)	integer(int32)
prePage		integer(int32)	integer(int32)
size		integer(int32)	integer(int32)
startRow		integer(int64)	integer(int64)
total		integer(int64)	integer(int64)

响应示例:

{
	"endRow": 0,
	"hasNextPage": true,
	"hasPreviousPage": true,
	"isFirstPage": true,
	"isLastPage": true,
	"list": [
		{
			"approvalBy": "",
			"approvalDesc": "",
			"approvalId": "",
			"approvalStatus": "",
			"approvalTime": "",
			"dataId": "",
			"dataType": "",
			"delFlag": "",
			"isCurr": "",
			"tenantId": ""
		}
	],
	"navigateFirstPage": 0,
	"navigateLastPage": 0,
	"navigatePages": 0,
	"navigatepageNums": [],
	"nextPage": 0,
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"prePage": 0,
	"size": 0,
	"startRow": 0,
	"total": 0
}

查询数据审核详情

接口地址:/gym/dataApproval/{approvalId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
approvalId	approvalId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	数据审核详情Vo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
approvalBy	审核者	string
approvalDesc	审核描述	string
approvalId	审批ID	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string
approvalTime	审核时间	string(date-time)	string(date-time)
dataId	数据ID	string
dataType	数据类型	string
delFlag	删除标识;（0：未删除，1：已删除）	string
tenantId	租户ID	string

响应示例:

{
	"approvalBy": "",
	"approvalDesc": "",
	"approvalId": "",
	"approvalStatus": "",
	"approvalTime": "",
	"dataId": "",
	"dataType": "",
	"delFlag": "",
	"tenantId": ""
}

删除数据审核

接口地址:/gym/dataApproval/{approvalId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
approvalId	approvalId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

数据推荐关联

新增保存数据推荐关联

接口地址:/gym/dataRecommendRel/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "recommendId": 0,
  "recommendType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	新增数据推荐关联Dto	新增数据推荐关联Dto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
recommendId	推荐数据ID		false	integer(int64)
recommendType	推荐数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改保存数据推荐关联

接口地址:/gym/dataRecommendRel/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "recommendId": 0,
  "recommendType": "",
  "relId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	修改数据推荐关联Dto	修改数据推荐关联Dto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
recommendId	推荐数据ID		false	integer(int64)
recommendType	推荐数据类型		false	string
relId	关联ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据数据类型获取数据名称列表

接口地址:/gym/dataRecommendRel/getRecommendDataList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	数据类型(2：场馆；3：场地，4：文章，11：图片，12：视频，13：音频；14：场馆平面图)	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询数据推荐关联列表

接口地址:/gym/dataRecommendRel/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createEnd	结束时间：开始日期 yyyy-MM-dd HH:mm:ss	query	false	string
createStart	开始时间：开始日期 yyyy-MM-dd HH:mm:ss	query	false	string
dataType	数据类型	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PageInfo«数据推荐关联列表Vo»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
endRow		integer(int64)	integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	数据推荐关联列表Vo
createBy	创建者	string
createTime	创建时间	string(date-time)
dataId	数据ID	string
dataType	数据类型	string
delFlag	删除标志;（0：未删除，1：已删除）	string
recommendId	推荐数据ID	string
recommendType	推荐数据类型	string
relId	关联ID	string
tenantId	租户ID	string
navigateFirstPage		integer(int32)	integer(int32)
navigateLastPage		integer(int32)	integer(int32)
navigatePages		integer(int32)	integer(int32)
navigatepageNums		array
nextPage		integer(int32)	integer(int32)
pageNum		integer(int32)	integer(int32)
pageSize		integer(int32)	integer(int32)
pages		integer(int32)	integer(int32)
prePage		integer(int32)	integer(int32)
size		integer(int32)	integer(int32)
startRow		integer(int64)	integer(int64)
total		integer(int64)	integer(int64)

响应示例:

{
	"endRow": 0,
	"hasNextPage": true,
	"hasPreviousPage": true,
	"isFirstPage": true,
	"isLastPage": true,
	"list": [
		{
			"createBy": "",
			"createTime": "",
			"dataId": "",
			"dataType": "",
			"delFlag": "",
			"recommendId": "",
			"recommendType": "",
			"relId": "",
			"tenantId": ""
		}
	],
	"navigateFirstPage": 0,
	"navigateLastPage": 0,
	"navigatePages": 0,
	"navigatepageNums": [],
	"nextPage": 0,
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"prePage": 0,
	"size": 0,
	"startRow": 0,
	"total": 0
}

查询数据文件关联详情

接口地址:/gym/dataRecommendRel/{relId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	数据推荐关联详情Vo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
createBy	创建者	string
createTime	创建时间	string(date-time)	string(date-time)
dataId	数据ID	string
dataType	数据类型	string
delFlag	删除标志;（0：未删除，1：已删除）	string
recommendId	推荐数据ID	string
recommendType	推荐数据类型	string
relId	关联ID	string
tenantId	租户ID	string

响应示例:

{
	"createBy": "",
	"createTime": "",
	"dataId": "",
	"dataType": "",
	"delFlag": "",
	"recommendId": "",
	"recommendType": "",
	"relId": "",
	"tenantId": ""
}

删除数据文件关联

接口地址:/gym/dataRecommendRel/{relId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

数据文件关联

新增保存数据文件关联

接口地址:/gym/dataFileRel/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "fileId": 0,
  "fileType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	新增数据文件关联Dto	新增数据文件关联Dto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
fileId	文件ID		false	integer(int64)
fileType	文件类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改保存数据文件关联

接口地址:/gym/dataFileRel/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "fileId": 0,
  "fileType": "",
  "relId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	修改数据文件关联Dto	修改数据文件关联Dto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
fileId	文件ID		false	integer(int64)
fileType	文件类型		false	string
relId	关联ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询数据文件关联列表

接口地址:/gym/dataFileRel/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	query	false	integer(int64)
fileType	fileType	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PageInfo«关联文件详情Vo»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
endRow		integer(int64)	integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	关联文件详情Vo
fileDesc	关联文件简介	string
fileId	关联文件ID	string
fileName	关联文件名称	string
fileType	关联文件类型（1：图片，2：视频，3：音频，4：模型）	string
fileUrl	关联文件路径	string
videoAndModelFileCover	视频、模型文件封面	封面文件详情Vo	封面文件详情Vo
fileId	封面文件ID	string
fileName	封面文件名称	string
fileUrl	封面文件路径	string
navigateFirstPage		integer(int32)	integer(int32)
navigateLastPage		integer(int32)	integer(int32)
navigatePages		integer(int32)	integer(int32)
navigatepageNums		array
nextPage		integer(int32)	integer(int32)
pageNum		integer(int32)	integer(int32)
pageSize		integer(int32)	integer(int32)
pages		integer(int32)	integer(int32)
prePage		integer(int32)	integer(int32)
size		integer(int32)	integer(int32)
startRow		integer(int64)	integer(int64)
total		integer(int64)	integer(int64)

响应示例:

{
	"endRow": 0,
	"hasNextPage": true,
	"hasPreviousPage": true,
	"isFirstPage": true,
	"isLastPage": true,
	"list": [
		{
			"fileDesc": "",
			"fileId": "",
			"fileName": "",
			"fileType": 1,
			"fileUrl": "",
			"videoAndModelFileCover": {
				"fileId": "",
				"fileName": "",
				"fileUrl": ""
			}
		}
	],
	"navigateFirstPage": 0,
	"navigateLastPage": 0,
	"navigatePages": 0,
	"navigatepageNums": [],
	"nextPage": 0,
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"prePage": 0,
	"size": 0,
	"startRow": 0,
	"total": 0
}

查询数据文件关联详情

接口地址:/gym/dataFileRel/{relId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	数据文件关联详情Vo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
createBy	创建者	string
createTime	创建时间	string(date-time)	string(date-time)
dataId	数据ID	string
dataType	数据类型	string
delFlag	删除标志;（0：未删除，1：已删除）	string
fileId	文件ID	string
fileName	文件名称	string
fileType	文件类型	string
relId	关联ID	string
tenantId	租户ID	string

响应示例:

{
	"createBy": "",
	"createTime": "",
	"dataId": "",
	"dataType": "",
	"delFlag": "",
	"fileId": "",
	"fileName": "",
	"fileType": "",
	"relId": "",
	"tenantId": ""
}

删除数据文件关联

接口地址:/gym/dataFileRel/{relId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

文章管理

新增文章

接口地址:/gym/gymArticle

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "articleContent": "",
  "articleDesc": "",
  "articleModule": 1,
  "articleName": "",
  "coverFile": {
    "fileId": 0
  },
  "isComment": 1,
  "isPraise": 1,
  "isTop": 0,
  "relDataList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "relFileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "saveOrSubmit": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymArticleAddDto	gymArticleAddDto	body	true	新增文章Dto	新增文章Dto
articleContent	文章内容（活动详情）		false	string
articleDesc	文章简介（活动地点）		false	string
articleModule	所属模块（1：新闻动态，2：活动发布，3：体育馆介绍，4：用户服务协议，5：隐私政策）		false	string
articleName	文章名称（活动名称）		false	string
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
isComment	是否允许评论;（0：否，1：是）		false	string
isPraise	是否允许点赞;（0：否，1：是）		false	string
isTop	是否置顶;（0：否，1：是）		false	string
relDataList	推荐内容列表		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
relFileList	关联文件列表（不包含封面图片）		false	array	新增或修改关联多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：场馆平面图）		true	string
saveOrSubmit	操作（1：保存，2：提交）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改文章

接口地址:/gym/gymArticle

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "articleContent": "",
  "articleDesc": "",
  "articleId": 0,
  "articleModule": 1,
  "articleName": "",
  "coverFile": {
    "fileId": 0
  },
  "isComment": 1,
  "isPraise": 1,
  "isTop": 0,
  "relDataList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "relFileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "saveOrSubmit": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymArticleEditDto	gymArticleEditDto	body	true	修改文章Dto	修改文章Dto
articleContent	文章内容		false	string
articleDesc	文章简介		false	string
articleId	文章ID		true	integer(int64)
articleModule	所属模块（1：新闻动态，2：活动发布，3：体育馆介绍，4：用户服务协议，5：隐私政策）		false	string
articleName	文章名称		false	string
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
isComment	是否允许评论;（0：否，1：是）		false	string
isPraise	是否允许点赞;（0：否，1：是）		false	string
isTop	是否置顶;（0：否，1：是）		false	string
relDataList	推荐内容列表		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
relFileList	关联文件列表（不包含封面图片）		false	array	新增或修改关联多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：场馆平面图）		true	string
saveOrSubmit	操作（1：保存，2：提交）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

文章审核

接口地址:/gym/gymArticle/approve

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approveOpinion": "",
  "approveStatus": "",
  "articleId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymArticleApproveDto	gymArticleApproveDto	body	true	文章审核Dto	文章审核Dto
approveOpinion	审核意见		false	string
approveStatus	审核操作（1：通过，2：驳回）		true	string
articleId	文章ID		true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出查询文章列表

接口地址:/gym/gymArticle/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
articleModule	所属模块（1：新闻动态，2：活动发布，3：体育馆介绍，4：用户服务协议，5：隐私政策）	query	false	string
articleName	文章名称	query	false	string
articleStatus	文章状态;（0：待审核，1：已上架，2：已下架，4：已驳回，9：草稿）	query	false	array	string
createBy	发布者名称	query	false	string
isTop	是否置顶;（0：否，1：是）	query	false	string
onlineBeginTime	发布开始时间	query	false	string(date)
onlineEndTime	发布结束时间	query	false	string(date)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
updateBeginTime	编辑开始时间	query	false	string(date)
updateEndTime	编辑结束时间	query	false	string(date)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询文章列表

接口地址:/gym/gymArticle/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
articleModule	所属模块（1：新闻动态，2：活动发布，3：体育馆介绍，4：用户服务协议，5：隐私政策）	query	false	string
articleName	文章名称	query	false	string
articleStatus	文章状态;（0：待审核，1：已上架，2：已下架，4：已驳回，9：草稿）	query	false	array	string
createBy	发布者名称	query	false	string
isTop	是否置顶;（0：否，1：是）	query	false	string
onlineBeginTime	发布开始时间	query	false	string(date)
onlineEndTime	发布结束时间	query	false	string(date)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
updateBeginTime	编辑开始时间	query	false	string(date)
updateEndTime	编辑结束时间	query	false	string(date)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

文章下架

接口地址:/gym/gymArticle/offline/{articleId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleId	articleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

文章置顶与取消置顶

接口地址:/gym/gymArticle/toTop

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "articleId": 0,
  "isTop": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymArticleToTopDto	gymArticleToTopDto	body	true	文章置顶与取消Dto	文章置顶与取消Dto
articleId	文章ID		true	integer(int64)
isTop	置顶操作（1：置顶，2：取消置顶）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除文章

接口地址:/gym/gymArticle/{articleIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleIds	articleIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

获取文章详细信息

接口地址:/gym/gymArticle/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleId	articleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

消息推送

筛选场地用户列表

接口地址:/gym/gym/message/field

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
activeStatus		query	false	string
createEnd	注册时间：结束日期(10)	query	false	string
createStart	注册时间：开始日期(10)	query	false	string
dataType	数据类型:2：场馆， 3：场地	query	false	string
databaseAlias	数据库别名	query	false	string
fieldName	场地名称(10)	query	false	string
pushTag	推送标签	query	false	string
reserveType	预约类型(10)	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userAddress		query	false	string
venueName	场馆名称(10)	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

对用户消息进行推送

接口地址:/gym/gym/message/push

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
activeStatus		query	false	string
createEnd	注册时间：结束日期(10)	query	false	string
createStart	注册时间：开始日期(10)	query	false	string
dataType	数据类型: 3：场地	query	false	string
databaseAlias	数据库别名	query	false	string
fieldName	场地名称(10)	query	false	string
messageContent	消息模板内容	query	false	string
messageType	消息模板类型，1：验证码，2：短信通知，3：推广短信	query	false	string
planTime	预定计划时间	query	false	string(date-time)
pushId	消息推送ID	query	false	integer(int64)
pushNum	人数	query	false	integer(int32)
pushTag	推送标签	query	false	string
pushType	推送类型,1:立即推送,2:定时推送	query	false	string
reserveType	预约类型(10)	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userAddress		query	false	string
venueName	场馆名称(10)	query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户VIP卡

修改用户VIP

接口地址:/gym/card

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cardId": 0,
  "cardNo": 0,
  "reserveId": 0,
  "useNum": 0,
  "userAmout": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
userCardEditDto	修改用户VIP表Dto	body	true	UserCardAddDto	UserCardAddDto
cardId	用户卡Id		false	integer(int64)
cardNo	会员卡卡号		false	integer(int64)
reserveId	预约Id		false	integer(int64)
useNum	会员卡扣除次数		false	integer(int32)
userAmout	会员卡扣除金额		false	number
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

后台查询用户VIP列表

接口地址:/gym/card/listByCard

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	主键Id	query	false	integer(int64)
cardNo	会员卡卡号	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
userId	用户ID	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取用户VIP详细信息

接口地址:/gym/card/{cardId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	cardId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除用户VIP

接口地址:/gym/card/{cardId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardId	cardId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

用户VIP购买

修改用户VIP购买

接口地址:/gym/base

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "cardNo": 0,
  "isPay": "",
  "isReturn": "",
  "orderId": 0,
  "orderRemark": "",
  "orderStatus": "",
  "payType": "",
  "totalAmout": 0,
  "userCardNo": "",
  "userCardType": "",
  "userId": 0,
  "userName": "",
  "userNickName": "",
  "userOpenId": "",
  "userPhone": "",
  "userRealName": "",
  "vipEndDate": "",
  "vipId": 0,
  "vipStartDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
vipBaseEditDto	修改用户VIP购买表	body	true	VipBaseEditDto对象	VipBaseEditDto对象
cardNo	会员卡卡号		false	integer(int64)
isPay	是否购票;（0：否，1：是）		false	string
isReturn	退订状态		false	string
orderId	主键ID		false	integer(int64)
orderRemark	订单备注		false	string
orderStatus	订单状态		false	string
payType	付款方式		false	string
totalAmout	订单金额		false	number
userCardNo	用户身份证号码		false	string
userCardType	用户证件类型		false	string
userId	用户ID		false	integer(int64)
userName	用户名称		false	string
userNickName	用户昵称		false	string
userOpenId	用户微信ID		false	string
userPhone	用户手机号		false	string
userRealName	用户真实姓名		false	string
vipEndDate	VIP有效期截止		false	string(date-time)
vipId	会员卡ID		false	integer(int64)
vipStartDate	VIP有效期起始		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询用户VIP购买（类似订单）列表

接口地址:/gym/base/listByOrder

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string(date-time)
endTime	结束时间	query	false	string(date-time)
orderId	主键ID	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
totalAmout	订单金额	query	false	number
vipName	会员卡名称	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

VIP卡已退款

接口地址:/gym/base/overpassed/{orderId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

VIP卡退款

接口地址:/gym/base/refund/{orderId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取用户VIP购买详细信息

接口地址:/gym/base/{orderId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除用户VIP购买

接口地址:/gym/base/{orderId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

统计分析

查询注册用户统计

接口地址:/gym/analysis/countRegisteredUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
timeType	timeType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询浏览量统计

接口地址:/gym/analysis/countViewNum

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	dataType	query	true	string
timeType	timeType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询数据分类饼图

接口地址:/gym/analysis/dataTypePie

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	dataType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询预约详情

接口地址:/gym/analysis/reserveDetail

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约趋势

接口地址:/gym/analysis/reserveTrend

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
timeType	timeType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询浏览量TOP10

接口地址:/gym/analysis/viewNumTop

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	dataType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

评论管理

批量评论审核

接口地址:/gym/dataComment/approves

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approveStatus": "",
  "commentId": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCommentApprovalDTO	dataCommentApprovalDTO	body	true	DataCommentApprovalDto	DataCommentApprovalDto
approvalDesc	审核描述		false	string
approveStatus	审核操作（0：初始，1：通过，2：驳回）		false	string
commentId	评论ID		false	array	integer
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

文章订单（场馆）评论详情

接口地址:/gym/dataComment/detail/{commentId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
commentId	commentId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

评论管理列表

接口地址:/gym/dataComment/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
commentBy	评论人	query	false	string
commentContent	评论内容	query	false	string
commentStatus	评论状态 0初始，1通过，2不通过	query	false	string
dataType	数据类型 4文章，8订单	query	false	string
databaseAlias	数据库别名	query	false	string
endTime	结束时间	query	false	string
startTime	开始时间	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询文章和订单评论

接口地址:/gym/dataComment/noLogin/articleList/{dataId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询场馆评论

接口地址:/gym/dataComment/noLogin/venueList/{venueId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
venueId	venueId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

今日评论通过量，待审核量

接口地址:/gym/dataComment/num

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

预约场地配置管理

新增预约场地配置

接口地址:/gym/gymBusiness

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admissionNotice": "",
  "beginDay": 0,
  "beginTime": "",
  "businessHourDto": [
    {
      "hourEnd": "12:00",
      "hourPrice": 0,
      "hourStart": "08:00"
    }
  ],
  "businessType": "",
  "buyNotice": "",
  "closeDate": "2022-03-18,2022-03-19",
  "closeTime": "17:00",
  "contactName": "",
  "contactTel": "",
  "dayTicketMax": 0,
  "endDate": "2022-03-31",
  "fieldIds": "",
  "isRefund": "",
  "isRefundApproval": "",
  "onceTicketMax": 0,
  "openTime": "08:00",
  "payType": "",
  "periodPrice": 0,
  "periodPriceType": "",
  "refundNotice": "",
  "reserveEndTime": "",
  "reserveStartTime": "",
  "reserveType": "",
  "startDate": "2022-03-17",
  "ticketPrice": 0,
  "venueId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymBusinessAddDto	gymBusinessAddDto	body	true	新增预约场地配置Dto	新增预约场地配置Dto
admissionNotice	入场须知		false	string
beginDay	线上开放可预约周期		false	integer(int32)
beginTime	每日开放预约时间		false	string
businessHourDto	按时段定价-可预约时间段列表		false	array	预约场地配置新增及修改经营项目时段Dto
hourEnd	时段结束		false	string
hourPrice	明细价格		false	number
hourStart	时段开始		false	string
businessType	经营项目类型;（1：足球，2：篮球，3：羽毛球，4：网球，5：乒乓球，6：游泳，7：健身，8：桌球，9：拳击，10：击剑，11：其他）		false	string
buyNotice	购买须知		false	string
closeDate	闭馆日期（逗号分隔）		false	string
closeTime	闭馆时间		false	string
contactName	联系人		false	string
contactTel	联系人方式		false	string
dayTicketMax	每日可预订票数		false	integer(int32)
endDate	有效期截止		false	string(date)
fieldIds	场地ID（多选用,隔开）		false	string
isRefund	是否允许退订;（0：否，1：是）		false	string
isRefundApproval	退订是否需审核;（0：否，1：是）		false	string
onceTicketMax	单次限制购票数量		false	integer(int32)
openTime	开馆时间		false	string
payType	付款方式（多选）;（1：线上付款，2：线下付款）		false	string
periodPrice	时段单价（时段同价）		false	number
periodPriceType	时段定价类型（1：所有时段同价，2：按时段阶梯定价）		false	string
refundNotice	退订须知		false	string
reserveEndTime	所有时段同价-线上可预约结束时间		false	string
reserveStartTime	所有时段同价-线上可预约开始时间		false	string
reserveType	预约类型（1：按时段包场，2：购票入场）		false	string
startDate	有效期起始		false	string(date)
ticketPrice	门票价格		false	number
venueId	场馆ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改预约场地配置

接口地址:/gym/gymBusiness

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admissionNotice": "",
  "beginDay": 0,
  "beginTime": "",
  "businessHourDto": [
    {
      "hourEnd": "12:00",
      "hourPrice": 0,
      "hourStart": "08:00"
    }
  ],
  "businessId": 0,
  "businessType": "",
  "buyNotice": "",
  "closeDate": "2022-03-18,2022-03-19",
  "closeTime": "17:00",
  "contactName": "",
  "contactTel": "",
  "dayTicketMax": 0,
  "endDate": "2022-03-31",
  "fieldIds": "",
  "isRefund": "",
  "isRefundApproval": "",
  "onceTicketMax": 0,
  "openTime": "08:00",
  "payType": "",
  "periodPrice": 0,
  "periodPriceType": "",
  "refundNotice": "",
  "reserveEndTime": "",
  "reserveStartTime": "",
  "reserveType": "",
  "startDate": "2022-03-17",
  "ticketPrice": 0,
  "venueId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
gymBusinessEditDto	gymBusinessEditDto	body	true	修改预约场地配置Dto	修改预约场地配置Dto
admissionNotice	入场须知		false	string
beginDay	线上开放可预约周期		false	integer(int32)
beginTime	每日开放预约时间		false	string
businessHourDto	按时段定价-可预约时间段列表（注：预约类型为购票入场及按时段阶梯定价时，字段不传）		false	array	预约场地配置新增及修改经营项目时段Dto
hourEnd	时段结束		false	string
hourPrice	明细价格		false	number
hourStart	时段开始		false	string
businessId	经营项目列表ID		true	integer(int64)
businessType	经营项目类型;（1：足球，2：篮球，3：羽毛球，4：网球，5：乒乓球，6：游泳，7：健身，8：桌球，9：拳击，10：击剑，11：其他）		false	string
buyNotice	购买须知（注：预约类型为按时段包场时，字段传null）		false	string
closeDate	闭馆日期（逗号分隔）		false	string
closeTime	闭馆时间		false	string
contactName	联系人		false	string
contactTel	联系人方式		false	string
dayTicketMax	每日可预订票数（注：预约类型为按时段包场时，字段传null）		false	integer(int32)
endDate	有效期截止		false	string(date)
fieldIds	场地ID（多选用,隔开）		false	string
isRefund	是否允许退订;（0：否，1：是）		false	string
isRefundApproval	退订是否需审核;（0：否，1：是）		false	string
onceTicketMax	单次限制购票数量（注：预约类型为按时段包场时，字段传null）		false	integer(int32)
openTime	开馆时间		false	string
payType	付款方式（多选）;（1：线上付款，2：线下付款）		false	string
periodPrice	时段单价（时段同价）（注：预约类型为购票入场时，字段传null）		false	number
periodPriceType	时段定价类型（1：所有时段同价，2：按时段阶梯定价）（注：预约类型为购票入场时，字段传null）		false	string
refundNotice	退订须知		false	string
reserveEndTime	所有时段同价-线上可预约结束时间（注：预约类型为购票入场时，字段传null）		false	string
reserveStartTime	所有时段同价-线上可预约开始时间（注：预约类型为购票入场时，字段传null）		false	string
reserveType	预约类型（1：按时段包场，2：购票入场）		false	string
startDate	有效期起始		false	string(date)
ticketPrice	门票价格（注：预约类型为按时段包场时，字段传null）		false	number
venueId	场馆ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询体育馆预约场地配置列表

接口地址:/gym/gymBusiness/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessType	经营项目;（1：足球，2：篮球，3：羽毛球，4：网球，5：乒乓球，6：游泳，7：健身，8：桌球，9：拳击，10：击剑，11：其他）	query	false	string
reserveType	预约类型（1：按时段包场，2：购票入场）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
venueName	所属场馆	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

新增预约获取预约场地配置列表

接口地址:/gym/gymBusiness/select/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessType	经营项目类型	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除预约场地配置

接口地址:/gym/gymBusiness/{businessIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessIds	businessIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

获取体育馆预约场地配置详细信息

接口地址:/gym/gymBusiness/{businessId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessId	businessId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

预约要素-前台用户

新增预约

接口地址:/gym/front/reserve/addReserve

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "businessId": 0,
  "detailAddDtoS": [
    {
      "detailHour": "",
      "detailPrice": 0,
      "fieldId": 0,
      "reserveDate": ""
    }
  ],
  "payType": "",
  "reserveNum": 0,
  "reserveType": "",
  "totalAmout": 0,
  "venueId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
addDto	addDto	body	true	BaseOnAddDto	BaseOnAddDto
businessId	经营项目ID（根据参数查询得）		false	integer(int64)
detailAddDtoS	预约明细		false	array	DetailAddDto
detailHour	明细时间段		false	string
detailPrice	明细价格		false	number
fieldId	场地ID		false	integer
reserveDate	预约日期		false	string
payType	购票方式{1:线上购买 2：线下购买 3：会员卡}		false	string
reserveNum	预订票数（购票入场）		false	integer(int32)
reserveType	预约类型		false	string
totalAmout	预约单金额		false	number
venueId	场馆ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

取消退订申请

接口地址:/gym/front/reserve/cancelOptOutApply/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

预约列表

接口地址:/gym/front/reserve/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createTimeEnd	预约时间止	query	false	string(date-time)
createTimeStart	预约时间起	query	false	string(date-time)
fieldId	场地id	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
reqType	请求类型{0：后台，1：移动端}	query	false	string
reserveChannel	预约渠道{2:线上 1：线下}	query	false	string
reserveType	预约类型{1:按时段包场 2：购票入场}	query	false	string
status	预约单状态{0：待支付 1:待使用 2：待评价 3：已评价 4：退款审核中 5：已退订 6：已驳回 7：已取消}	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userPhone	用户手机号	query	false	string
venueId	场馆id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

退订申请

接口地址:/gym/front/reserve/optOutApply/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约详情

接口地址:/gym/front/reserve/query/getBaseInfo/{reserveId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

预约要素-运营后台

新增预约(线下)

接口地址:/gym/reserve/addReserve

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "businessId": 0,
  "businessType": "",
  "detailAddDtoS": [
    {
      "detailHour": "",
      "detailPrice": 0,
      "fieldId": 0,
      "reserveDate": ""
    }
  ],
  "detailField": "",
  "payType": "",
  "reserveNum": 0,
  "reserveRemark": "",
  "reserveType": "",
  "totalAmout": 0,
  "userCardNo": "",
  "userPhone": "",
  "userRealName": "",
  "venueId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
addReserveDto	addReserveDto	body	true	AddReserveDto	AddReserveDto
businessId	经营项目ID（根据参数查询得）		false	integer(int64)
businessType	经营项目类型		false	string
detailAddDtoS	预约明细		false	array	DetailAddDto
detailHour	明细时间段		false	string
detailPrice	明细价格		false	number
fieldId	场地ID		false	integer
reserveDate	预约日期		false	string
detailField	预订场地		false	string
payType	付款方式		false	string
reserveNum	预订票数（购票入场）		false	integer(int32)
reserveRemark	预约备注		false	string
reserveType	预约类型		false	string
totalAmout	预约单金额		false	number
userCardNo	用户身份证号		false	string
userPhone	用户手机号		false	string
userRealName	用户真实姓名		false	string
venueId	场馆ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

取消预约

接口地址:/gym/reserve/cancle/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据日期查询余票

接口地址:/gym/reserve/getTicketNum/{businessId}/{nowDate}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
businessId	businessId	path	true	integer(int64)
nowDate	nowDate	path	true	string(date)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

预约列表

接口地址:/gym/reserve/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createTimeEnd	预约时间止	query	false	string(date-time)
createTimeStart	预约时间起	query	false	string(date-time)
fieldId	场地id	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
reqType	请求类型{0：后台，1：移动端}	query	false	string
reserveChannel	预约渠道{2:线上 1：线下}	query	false	string
reserveType	预约类型{1:按时段包场 2：购票入场}	query	false	string
status	预约单状态{0：待支付 1:待使用 2：待评价 3：已评价 4：退款审核中 5：已退订 6：已驳回 7：已取消}	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userPhone	用户手机号	query	false	string
venueId	场馆id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

退订

接口地址:/gym/reserve/optOut

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
reserveIds	reserveIds	query	true	array	integer
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

退订审核

接口地址:/gym/reserve/optOutApproval

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approvalStatus": "",
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
addDto	addDto	body	true	新增数据审核Dto	新增数据审核Dto
approvalDesc	审核描述		false	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约详情

接口地址:/gym/reserve/query/getBaseInfo/{reserveId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改预约

接口地址:/gym/reserve/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "businessId": 0,
  "businessType": "",
  "detailAddDtoS": [
    {
      "detailHour": "",
      "detailPrice": 0,
      "fieldId": 0,
      "reserveDate": ""
    }
  ],
  "detailField": "",
  "payType": "",
  "reserveNum": 0,
  "reserveRemark": "",
  "reserveType": "",
  "totalAmout": 0,
  "userCardNo": "",
  "userPhone": "",
  "userRealName": "",
  "venueId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
addReserveDto	addReserveDto	body	true	AddReserveDto	AddReserveDto
businessId	经营项目ID（根据参数查询得）		false	integer(int64)
businessType	经营项目类型		false	string
detailAddDtoS	预约明细		false	array	DetailAddDto
detailHour	明细时间段		false	string
detailPrice	明细价格		false	number
fieldId	场地ID		false	integer
reserveDate	预约日期		false	string
detailField	预订场地		false	string
payType	付款方式		false	string
reserveNum	预订票数（购票入场）		false	integer(int32)
reserveRemark	预约备注		false	string
reserveType	预约类型		false	string
totalAmout	预约单金额		false	number
userCardNo	用户身份证号		false	string
userPhone	用户手机号		false	string
userRealName	用户真实姓名		false	string
venueId	场馆ID		false	integer(int64)
reserveId	reserveId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

核销

接口地址:/gym/reserve/writeOff/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

系统模块接口文档

简介:系统模块接口文档

HOST:xxxx.xxxx.xxxx

联系人:

Version:

接口路径:/museum/v2/api-docs

[TOC]

前台博物馆基础

前台查询博物馆基础详细信息

接口地址:/museum/front/museumBase/noLogin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台博物馆展厅

查询博物馆展厅列表

接口地址:/museum/front/museumHall/noLogin/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
floorId	楼层id	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取博物馆展厅详细信息

接口地址:/museum/front/museumHall/noLogin/{hallId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
hallId	hallId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台博物馆楼层

前台查询博物馆楼层列表

接口地址:/museum/front/museumFloor/noLogin/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string
endTime	结束时间	query	false	string
floorStatus	楼层状态	query	false	string
museumId	博物馆Id	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台博物馆藏品

展厅查询博物馆藏品列表

接口地址:/museum/front/museumExhibit/noLogin/listByHall

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string
endTime	结束时间	query	false	string
exhibitEra	藏品年代（取config_id）	query	false	integer(int64)
exhibitModule	藏品所属模块	query	false	string
exhibitName	藏品名称	query	false	string
exhibitStatus	展品状态;（0：待审核，1：已上架，2：已下架，4：已驳回，9：草稿）	query	false	array	string
exhibitTexture	藏品质地（取config_id）	query	false	integer(int64)
exhibitType	藏品分类（取config_id）	query	false	integer(int64)
hallId	展厅ID	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取博物馆藏品详细信息

接口地址:/museum/front/museumExhibit/noLogin/{exhibitId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitId	exhibitId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台博物馆藏品分类配置

前台查询博物馆藏品分类配置列表

接口地址:/museum/front/exhibitConfig/noLogin/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string
configName	配置名称	query	false	string
endTime	结束时间	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台展览活动管理

前台查询博物馆展览活动列表

接口地址:/museum/front/museumExhibition/noLogin/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台获取博物馆展览详细信息

接口地址:/museum/front/museumExhibition/noLogin/{exhibitionId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitionId	exhibitionId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台收藏管理

添加收藏

接口地址:/museum/front/dataCollection/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCollectionAddDTO	dataCollectionAddDTO	body	true	添加收藏Dto	添加收藏Dto
dataId	数据ID		false	integer(int64)
dataType	收藏类型 4:藏品,5:文章,6:展览		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

取消收藏

接口地址:/museum/front/dataCollection/del/{dataId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

查询收藏列表

接口地址:/museum/front/dataCollection/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
collectionBy	收藏人	query	false	string
dataName	收藏名称	query	false	string
dataType	收藏类型 4:藏品,5:文章,6:展览	query	false	string
reqType	请求类型{0：后台，1：前台}	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

批量取消收藏

接口地址:/museum/front/dataCollection/removes/{collectionIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
collectionIds	collectionIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

前台文章管理

前台获取用户服务协议和隐私政策（contentType 1：用户服务协议，2：隐私政策）

接口地址:/museum/front/museumArticle/noLogin/getAgreementAndPolicy

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
contentType	contentType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台获取博物馆展馆概况

接口地址:/museum/front/museumArticle/noLogin/getMuseumSituation

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台查询文章列表

接口地址:/museum/front/museumArticle/noLogin/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleModule	所属模块（1：精品文章，2：展馆动态	query	false	string
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

前台获取文章详细信息

接口地址:/museum/front/museumArticle/noLogin/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleId	articleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

前台点赞

增加点赞

接口地址:/museum/front/praise/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataPraiseAddDTO	dataPraiseAddDTO	body	true	插入点赞记录	插入点赞记录
dataId	点赞类型id		false	integer(int64)
dataType	点赞类型 4：藏品 5：文章		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

我的点赞

接口地址:/museum/front/praise/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	点赞类型 4：藏品，5：文章	query	false	string
praiseBy	点赞人	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除点赞

接口地址:/museum/front/praise/remove/{dataId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

前台评论

新增评论

接口地址:/museum/front/dataComment/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "commentBy": "",
  "commentContent": "",
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCommentAddDTO	dataCommentAddDTO	body	true	添加评论	添加评论
commentBy	评论人		false	string
commentContent	评论内容		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型 4:藏品,5:文章		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改评论

接口地址:/museum/front/dataComment/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "commentContent": "",
  "commentId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCommentEditDTO	dataCommentEditDTO	body	true	修改评论	修改评论
commentContent	评论内容		false	string
commentId	评论ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询我的评论列表

接口地址:/museum/front/dataComment/myList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
commentBy	评论者	query	false	string
commentStatus	评论状态 0初始，1通过，2不通过	query	false	string
databaseAlias	数据库别名	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询文章藏品评论

接口地址:/museum/front/dataComment/noLogin/list/{dataId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除评论

接口地址:/museum/front/dataComment/remove/{commentId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
commentId	commentId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

博物馆基础

获取博物馆基础详细信息

接口地址:/museum/museumBase

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

新增博物馆基础

接口地址:/museum/museumBase

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "areaCode": "",
  "cityCode": "",
  "museumAddress": "",
  "museumDesc": "",
  "museumId": 0,
  "museumLogo": "",
  "museumName": "",
  "payChannel": "",
  "phone": "",
  "provinceCode": "",
  "themeColor": "",
  "wechatAccount": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumBaseAddDto	博物馆基础Dto	body	true	MuseumBaseAddDto对象	MuseumBaseAddDto对象
areaCode	区编码		false	string
cityCode	市编码		false	string
museumAddress	博物馆地址		false	string
museumDesc	博物馆简介		false	string
museumId	主键ID		false	integer(int64)
museumLogo	博物馆LOGO		false	string
museumName	博物馆名称		false	string
payChannel	支付渠道		false	string
phone	手机号		false	string
provinceCode	省编码		false	string
themeColor	主题颜色		false	string
wechatAccount	微信账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改博物馆基础

接口地址:/museum/museumBase

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "areaCode": "",
  "cityCode": "",
  "museumAddress": "",
  "museumDesc": "",
  "museumId": 0,
  "museumLogo": "",
  "museumName": "",
  "payChannel": "",
  "phone": "",
  "provinceCode": "",
  "themeColor": "",
  "wechatAccount": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumBaseEditDto	博物馆基础Dto	body	true	MuseumBaseAddDto对象	MuseumBaseAddDto对象
areaCode	区编码		false	string
cityCode	市编码		false	string
museumAddress	博物馆地址		false	string
museumDesc	博物馆简介		false	string
museumId	主键ID		false	integer(int64)
museumLogo	博物馆LOGO		false	string
museumName	博物馆名称		false	string
payChannel	支付渠道		false	string
phone	手机号		false	string
provinceCode	省编码		false	string
themeColor	主题颜色		false	string
wechatAccount	微信账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取行政区域

接口地址:/museum/museumBase/getAddress

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
parentCode	父地区编码	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询博物馆基础列表

接口地址:/museum/museumBase/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除博物馆基础

接口地址:/museum/museumBase/{museumId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
museumId	museumId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

博物馆展厅

新增博物馆展厅

接口地址:/museum/museumHall

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "floorId": 0,
  "hallArea": 0,
  "hallDesc": "",
  "hallName": "",
  "recommendExhibitList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumHallAddDto	博物馆展厅Dto	body	true	MuseumHallAddDto对象	MuseumHallAddDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileList	文件List		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
floorId	楼层Id		false	integer(int64)
hallArea	展厅面积		false	integer(int32)
hallDesc	展厅描述		false	string
hallName	展厅名称		false	string
recommendExhibitList	推荐展品List		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改博物馆展厅

接口地址:/museum/museumHall

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "hallArea": 0,
  "hallDesc": "",
  "hallId": 0,
  "hallName": "",
  "hallStatus": "",
  "recommendExhibitList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumHallEditDto	博物馆展厅Dto	body	true	MuseumHallEditDto对象	MuseumHallEditDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileList	文件List		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
hallArea	展厅面积		false	integer(int32)
hallDesc	展厅描述		false	string
hallId	主键ID		false	integer(int64)
hallName	展厅名称		false	string
hallStatus	展厅状态;（0：停用，1：开放）		false	string
recommendExhibitList	推荐展品List		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

展厅启用与停用

接口地址:/museum/museumHall/hallStatus

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "hallId": 0,
  "hallStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumHallStatusDto	博物馆展厅Dto	body	true	MuseumHallStatusDto对象	MuseumHallStatusDto对象
hallId	展厅主键ID		false	integer(int64)
hallStatus	展厅状态;（0：停用，1：开放）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询博物馆展厅列表

接口地址:/museum/museumHall/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
floorId	楼层id	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取博物馆展厅详细信息

接口地址:/museum/museumHall/{hallId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
hallId	hallId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除博物馆展厅

接口地址:/museum/museumHall/{hallId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
hallId	hallId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

博物馆楼层

新增博物馆楼层

接口地址:/museum/museumFloor

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "floorArea": 0,
  "floorDesc": "",
  "floorName": "",
  "museumId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumFloorAddDto	博物馆楼层Dto	body	true	MuseumFloorAddDto对象	MuseumFloorAddDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileList	文件List		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
floorArea	楼层面积		false	integer(int32)
floorDesc	楼层描述		false	string
floorName	楼层名称		false	string
museumId	博物馆Id		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改博物馆楼层

接口地址:/museum/museumFloor

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "floorArea": 0,
  "floorDesc": "",
  "floorId": 0,
  "floorName": "",
  "floorStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumFloorEditDto	博物馆楼层Dto	body	true	MuseumFloorEditDto对象	MuseumFloorEditDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileList	文件List		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
floorArea	楼层面积		false	integer(int32)
floorDesc	楼层描述		false	string
floorId	主键ID		false	integer(int64)
floorName	楼层名称		false	string
floorStatus	楼层状态;（0：停用，1：开放）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

楼层启用与停用

接口地址:/museum/museumFloor/floorStatus

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "floorId": 0,
  "floorStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumFloorStatusDto	博物馆楼层Dto	body	true	MuseumFloorStatusDto对象	MuseumFloorStatusDto对象
floorId	楼层主键ID		false	integer(int64)
floorStatus	楼层状态;（0：停用，1：开放）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询博物馆楼层列表

接口地址:/museum/museumFloor/listByUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string
endTime	结束时间	query	false	string
floorStatus	楼层状态	query	false	string
museumId	博物馆Id	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取博物馆楼层详细信息

接口地址:/museum/museumFloor/{floorId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
floorId	floorId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除博物馆楼层

接口地址:/museum/museumFloor/{floorId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
floorId	floorId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

博物馆藏品

新增博物馆藏品

接口地址:/museum/museumExhibit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "exhibitDesc": "",
  "exhibitEra": 0,
  "exhibitExtend": "",
  "exhibitModule": "",
  "exhibitName": "",
  "exhibitNo": "",
  "exhibitSummary": "",
  "exhibitTexture": 0,
  "exhibitType": 0,
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "hallId": 0,
  "isComment": "",
  "isPraise": "",
  "isTop": "",
  "recommendThing": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "saveOrSubmit": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumExhibitAddDto	博物馆藏品Dto	body	true	MuseumExhibitAddDto对象	MuseumExhibitAddDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
exhibitDesc	藏品详情		false	string
exhibitEra	藏品年代（取config_id）		false	integer(int64)
exhibitExtend	藏品扩展阅读		false	string
exhibitModule	藏品所属模块		false	string
exhibitName	藏品名称		false	string
exhibitNo	藏品编号		false	string
exhibitSummary	藏品简介		false	string
exhibitTexture	藏品质地（取config_id）		false	integer(int64)
exhibitType	藏品分类（取config_id）		false	integer(int64)
fileList	文件List		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
hallId	展厅ID		false	integer(int64)
isComment	是否允许评论;（0：否，1：是）		false	string
isPraise	是否允许点赞;（0：否，1：是）		false	string
isTop	是否置顶;（0：否，1：是）		false	string
recommendThing	推荐内容List		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
saveOrSubmit	操作（1：保存，2：提交）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改博物馆藏品

接口地址:/museum/museumExhibit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "exhibitDesc": "",
  "exhibitEra": 0,
  "exhibitExtend": "",
  "exhibitId": 0,
  "exhibitModule": "",
  "exhibitName": "",
  "exhibitNo": "",
  "exhibitStatus": "",
  "exhibitSummary": "",
  "exhibitTexture": 0,
  "exhibitType": 0,
  "fileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "hallId": 0,
  "isComment": "",
  "isPraise": "",
  "isTop": "",
  "recommendThing": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "saveOrSubmit": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumExhibitEditDto	博物馆藏品Dto	body	true	MuseumExhibitEditDto对象	MuseumExhibitEditDto对象
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
exhibitDesc	藏品详情		false	string
exhibitEra	藏品年代（取config_id）		false	integer(int64)
exhibitExtend	藏品扩展阅读		false	string
exhibitId	主键ID		false	integer(int64)
exhibitModule	藏品所属模块		false	string
exhibitName	藏品名称		false	string
exhibitNo	藏品编号		false	string
exhibitStatus	藏品状态;（0：初始，1：通过，2：不通过）		false	string
exhibitSummary	藏品简介		false	string
exhibitTexture	藏品质地（取config_id）		false	integer(int64)
exhibitType	藏品分类（取config_id）		false	integer(int64)
fileList	文件List		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
hallId	展厅ID		false	integer(int64)
isComment	是否允许评论;（0：否，1：是）		false	string
isPraise	是否允许点赞;（0：否，1：是）		false	string
isTop	是否置顶;（0：否，1：是）		false	string
recommendThing	推荐内容List		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
saveOrSubmit	操作（1：保存，2：提交）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

藏品审核

接口地址:/museum/museumExhibit/approve

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approveOpinion": "",
  "approveStatus": "",
  "exhibitId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumExhibitApproveDto	museumExhibitApproveDto	body	true	展品审核Dto	展品审核Dto
approveOpinion	审核意见		false	string
approveStatus	审核操作（1：通过，2：驳回）		true	string
exhibitId	展品ID		true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询博物馆藏品列表

接口地址:/museum/museumExhibit/listByHall

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string
endTime	结束时间	query	false	string
exhibitEra	藏品年代（取config_id）	query	false	integer(int64)
exhibitModule	藏品所属模块	query	false	string
exhibitName	藏品名称	query	false	string
exhibitStatus	展品状态;（0：待审核，1：已上架，2：已下架，4：已驳回，9：草稿）	query	false	array	string
exhibitTexture	藏品质地（取config_id）	query	false	integer(int64)
exhibitType	藏品分类（取config_id）	query	false	integer(int64)
hallId	展厅ID	query	false	integer(int64)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

展品下架

接口地址:/museum/museumExhibit/offline/{exhibitId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitId	exhibitId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

展品置顶与取消置顶

接口地址:/museum/museumExhibit/toTop

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "exhibitId": 0,
  "isTop": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumExhibitToTopDto	museumExhibitToTopDto	body	true	展品置顶与取消Dto	展品置顶与取消Dto
exhibitId	展品ID		true	integer(int64)
isTop	置顶操作（1：置顶，2：取消置顶）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取博物馆藏品详细信息

接口地址:/museum/museumExhibit/{exhibitId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitId	exhibitId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除博物馆藏品

接口地址:/museum/museumExhibit/{exhibitId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitId	exhibitId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

博物馆藏品分类配置

新增博物馆藏品分类配置

接口地址:/museum/config

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "configLevel": 0,
  "configName": "",
  "configType": "",
  "parentId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
exhibitConfigAddDto	藏品分类配置Dto	body	true	ExhibitConfigAddDto对象	ExhibitConfigAddDto对象
configLevel	配置级别		false	integer(int32)
configName	配置名称		false	string
configType	配置类型(1.分类,2.质地,3.年代)		false	string
parentId	父类ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改博物馆藏品分类配置

接口地址:/museum/config

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "configId": 0,
  "configLevel": 0,
  "configName": "",
  "configType": "",
  "parentId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
exhibitConfigEditDto	藏品分类配置Dto	body	true	ExhibitConfigEditDto对象	ExhibitConfigEditDto对象
configId	主键Id		false	integer(int64)
configLevel	配置级别		false	integer(int32)
configName	配置名称		false	string
configType	配置类型		false	string
parentId	父类ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询博物馆藏品分类配置列表

接口地址:/museum/config/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	开始时间	query	false	string
configName	配置名称	query	false	string
endTime	结束时间	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取博物馆藏品分类配置详细信息

接口地址:/museum/config/{configId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
configId	configId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除博物馆藏品分类配置

接口地址:/museum/config/{configId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
configId	configId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

多媒体文件管理

新增多媒体文件

接口地址:/museum/museumFile

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileDesc": "",
  "fileName": "",
  "fileType": 1,
  "fileUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumFileAddDto	museumFileAddDto	body	true	新增多媒体文件Dto	新增多媒体文件Dto
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileDesc	文件简介		true	string
fileName	文件名称		true	string
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
fileUrl	文件路径（相对）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改多媒体文件

接口地址:/museum/museumFile

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "coverFile": {
    "fileId": 0
  },
  "fileDesc": "",
  "fileId": 0,
  "fileName": "",
  "fileUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumFileEditDto	museumFileEditDto	body	true	修改多媒体文件Dto	修改多媒体文件Dto
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
fileDesc	文件简介		false	string
fileId	文件ID		true	integer(int64)
fileName	文件名称		false	string
fileUrl	文件路径（相对）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出多媒体文件列表

接口地址:/museum/museumFile/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	操作开始时间	query	false	string(date)
endTime	操作结束时间	query	false	string(date)
fileName	文件名称	query	false	string
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

判断文件是否已经存在

接口地址:/museum/museumFile/isExist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileName	文件名称	query	true	string
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

判断文件是否被引用

接口地址:/museum/museumFile/isQuote/{fileIds}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileIds	fileIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询多媒体文件列表

接口地址:/museum/museumFile/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
beginTime	操作开始时间	query	false	string(date)
endTime	操作结束时间	query	false	string(date)
fileName	文件名称	query	false	string
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除多媒体文件

接口地址:/museum/museumFile/{fileIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileIds	fileIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

获取多媒体文件详细信息

接口地址:/museum/museumFile/{fileId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
fileId	fileId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

展览活动配置管理

新增展览

接口地址:/museum/museumExhibition

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "beginDay": 0,
  "beginTime": "08:00",
  "closeDate": "",
  "closeTime": "17:00",
  "coverFile": {
    "fileId": 0
  },
  "endDate": "",
  "exhibitionAddress": "",
  "exhibitionName": "",
  "isPay": "",
  "openTime": "08:00",
  "payType": "",
  "refundRule": "",
  "relDataList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "startDate": "",
  "ticketChildren": 0,
  "ticketDiscount": 0,
  "ticketPrice": 0,
  "touristMax": 0,
  "visitNotice": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumExhibitionAddDto	museumExhibitionAddDto	body	true	新增展览活动Dto	新增展览活动Dto
beginDay	线上开放可预约周期		false	integer(int32)
beginTime	每日开放预约时间		false	string
closeDate	闭馆日期（逗号分隔）		false	string
closeTime	闭馆时间		false	string
coverFile	封面文件		false	楼层、展厅、藏品、文章、视频、模型封面文件新增及修改Dto	楼层、展厅、藏品、文章、视频、模型封面文件新增及修改Dto
fileId	封面文件ID		false	integer
endDate	有效期截止		false	string(date)
exhibitionAddress	展览地址		false	string
exhibitionName	展览名称		false	string
isPay	是否购票;（0：否，1：是）		false	string
openTime	开馆时间		false	string
payType	购票方式（多选）;（1：线上购买，2：现场购买）		false	string
refundRule	退票规则		false	string
relDataList	推荐内容列表		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
startDate	有效期起始		false	string(date)
ticketChildren	儿童票价格		false	number
ticketDiscount	优惠门票价格		false	number
ticketPrice	门票价格		false	number
touristMax	游客上限（每日）		false	integer(int32)
visitNotice	参观须知		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改展览

接口地址:/museum/museumExhibition

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "beginDay": 0,
  "beginTime": "08:00",
  "closeDate": "",
  "closeTime": "17:00",
  "coverFile": {
    "fileId": 0
  },
  "endDate": "",
  "exhibitionAddress": "",
  "exhibitionId": 0,
  "exhibitionName": "",
  "isPay": "",
  "openTime": "08:00",
  "payType": "",
  "refundRule": "",
  "relDataList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "startDate": "",
  "ticketChildren": 0,
  "ticketDiscount": 0,
  "ticketPrice": 0,
  "touristMax": 0,
  "visitNotice": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumExhibitionEditDto	museumExhibitionEditDto	body	true	修改展览Dto	修改展览Dto
beginDay	线上开放可预约周期		false	integer(int32)
beginTime	每日开放预约时间		false	string
closeDate	闭馆日期（逗号分隔）		false	string
closeTime	闭馆时间		false	string
coverFile	封面文件		false	楼层、展厅、藏品、文章、视频、模型封面文件新增及修改Dto	楼层、展厅、藏品、文章、视频、模型封面文件新增及修改Dto
fileId	封面文件ID		false	integer
endDate	有效期截止		false	string(date)
exhibitionAddress	展览地址		false	string
exhibitionId	展览ID		true	integer(int64)
exhibitionName	展览名称		false	string
isPay	是否购票;（0：否，1：是）		false	string
openTime	开馆时间		false	string
payType	购票方式（多选）;（1：线上购买，2：现场购买）		false	string
refundRule	退票规则		false	string
relDataList	推荐内容列表		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
startDate	有效期起始		false	string(date)
ticketChildren	儿童票价格		false	number
ticketDiscount	优惠门票价格		false	number
ticketPrice	门票价格		false	number
touristMax	游客上限（每日）		false	integer(int32)
visitNotice	参观须知		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出博物馆展览查询列表

接口地址:/museum/museumExhibition/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitionName	展览配置名称	query	false	string
isPay	是否购票;（0：否，1：是）	query	false	string
openOrderBeginTime	开放预约开始时间	query	false	string(date)
openOrderEndTime	开放预约结束时间	query	false	string(date)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取周期性闭馆日期

接口地址:/museum/museumExhibition/getCloseDate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
closeDateArray	具体哪天（每周就传1-7 每月就传1-31 多选用逗号隔开）	query	true	array	integer
cycleType	闭馆周期类型（1：每周，2：每月）	query	true	string
endDate	有效期截止	query	true	string(date)
startDate	有效期起始	query	true	string(date)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询博物馆展览活动列表

接口地址:/museum/museumExhibition/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitionName	展览配置名称	query	false	string
isPay	是否购票;（0：否，1：是）	query	false	string
openOrderBeginTime	开放预约开始时间	query	false	string(date)
openOrderEndTime	开放预约结束时间	query	false	string(date)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

新增预约获取展览活动列表

接口地址:/museum/museumExhibition/select/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除展览

接口地址:/museum/museumExhibition/{exhibitionIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitionIds	exhibitionIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

获取博物馆展览详细信息

接口地址:/museum/museumExhibition/{exhibitionId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitionId	exhibitionId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

推送记录

批量删除推送数据

接口地址:/museum/message/userList/deletes

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
ids	ids	query	false	array	integer
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取推送数据详情

接口地址:/museum/message/userList/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
activeStatus		query	false	string
articleName	文章名称(100)	query	false	string
createEnd	注册时间：结束日期(10)	query	false	string
createStart	注册时间：开始日期(10)	query	false	string
dataType	数据类型: 4：藏品 5：文章 6：展览	query	false	string
databaseAlias	数据库别名	query	false	string
exhibitType	藏品类型(10)	query	false	string
exhibitionName	展览名称(100)	query	false	string
pushId	pushId	query	false	integer(int64)
pushTag	推送标签	query	false	string
reserveType	预约类型(10)	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userAddress		query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取推送数据记录列表

接口地址:/museum/message/userList/recordList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	数据类型	query	false	string
pushStatus	推送状态,0:未推送,1:已推送	query	false	string
pushTimeEnd	推送时间止	query	false	string(date-time)
pushTimeStart	推送时间起	query	false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除推送数据

接口地址:/museum/message/userList/update

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
pushId	pushId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

支付相关

支付信息

接口地址:/museum/front/userPay/getPay/{orderId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

支付结果通知(应为第三方回调接口，接入后修改)

接口地址:/museum/front/userPay/payCallBack/{orderId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
orderId	orderId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

去支付

接口地址:/museum/front/userPay/toPay

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "orderId": 0,
  "orderType": "",
  "payAmout": 0,
  "payChannel": "",
  "payMethod": "",
  "payType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
addDto	addDto	body	true	UserPayAddDto	UserPayAddDto
orderId	订单ID		false	integer(int64)
orderType	订单类型		false	string
payAmout	支付金额		false	number
payChannel	支付渠道		false	string
payMethod	支付方式		false	string
payType	支付类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

数据审核

新增保存数据审核

接口地址:/museum/dataApproval/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approvalStatus": "",
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	DataApprovalAddDto	DataApprovalAddDto
approvalDesc	审核描述		false	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量新增数据审核(批量审核)

接口地址:/museum/dataApproval/adds

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

[
  {
    "approvalDesc": "",
    "approvalStatus": "",
    "dataId": 0,
    "dataType": ""
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dtos	dtos	body	true	array	DataApprovalAddDto
approvalDesc	审核描述		false	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	DataApprovalAddDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
approvalDesc	审核描述	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string
dataId	数据ID	integer(int64)	integer(int64)
dataType	数据类型	string

响应示例:

[
	{
		"approvalDesc": "",
		"approvalStatus": "",
		"dataId": 0,
		"dataType": ""
	}
]

修改保存数据审核

接口地址:/museum/dataApproval/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approvalId": 0,
  "approvalStatus": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	DataApprovalEditDto	DataApprovalEditDto
approvalDesc	审核描述		false	string
approvalId	审批ID		false	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量修改数据审核(批量审核)

接口地址:/museum/dataApproval/edits

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

[
  {
    "approvalDesc": "",
    "approvalId": 0,
    "approvalStatus": ""
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dtos	dtos	body	true	array	DataApprovalEditDto
approvalDesc	审核描述		false	string
approvalId	审批ID		false	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	DataApprovalEditDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
approvalDesc	审核描述	string
approvalId	审批ID	integer(int64)	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string

响应示例:

[
	{
		"approvalDesc": "",
		"approvalId": 0,
		"approvalStatus": ""
	}
]

查询数据审核列表

接口地址:/museum/dataApproval/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
approvalEnd	结束时间：审核时间	query	false	string
approvalStart	开始时间：审核时间	query	false	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	query	false	string
dataType	数据类型	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PageInfo«数据审核列表Vo»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
endRow		integer(int64)	integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	数据审核列表Vo
approvalBy	审核者	string
approvalDesc	审核描述	string
approvalId	审批ID	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string
approvalTime	审核时间	string(date-time)
dataId	数据ID	integer(int64)
dataType	数据类型	string
delFlag	删除标识;（0：未删除，1：已删除）	string
isCurr	是否最新审核记录;（0：否，1：是）	string
tenantId	租户ID	integer(int64)
navigateFirstPage		integer(int32)	integer(int32)
navigateLastPage		integer(int32)	integer(int32)
navigatePages		integer(int32)	integer(int32)
navigatepageNums		array
nextPage		integer(int32)	integer(int32)
pageNum		integer(int32)	integer(int32)
pageSize		integer(int32)	integer(int32)
pages		integer(int32)	integer(int32)
prePage		integer(int32)	integer(int32)
size		integer(int32)	integer(int32)
startRow		integer(int64)	integer(int64)
total		integer(int64)	integer(int64)

响应示例:

{
	"endRow": 0,
	"hasNextPage": true,
	"hasPreviousPage": true,
	"isFirstPage": true,
	"isLastPage": true,
	"list": [
		{
			"approvalBy": "",
			"approvalDesc": "",
			"approvalId": 0,
			"approvalStatus": "",
			"approvalTime": "",
			"dataId": 0,
			"dataType": "",
			"delFlag": "",
			"isCurr": "",
			"tenantId": 0
		}
	],
	"navigateFirstPage": 0,
	"navigateLastPage": 0,
	"navigatePages": 0,
	"navigatepageNums": [],
	"nextPage": 0,
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"prePage": 0,
	"size": 0,
	"startRow": 0,
	"total": 0
}

查询数据审核详情

接口地址:/museum/dataApproval/{approvalId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
approvalId	approvalId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	DataApprovalDetailsVo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
approvalBy	审核者	string
approvalDesc	审核描述	string
approvalId	审批ID	integer(int64)	integer(int64)
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）	string
approvalTime	审核时间	string(date-time)	string(date-time)
dataId	数据ID	integer(int64)	integer(int64)
dataType	数据类型	string
delFlag	删除标识;（0：未删除，1：已删除）	string
tenantId	租户ID	integer(int64)	integer(int64)

响应示例:

{
	"approvalBy": "",
	"approvalDesc": "",
	"approvalId": 0,
	"approvalStatus": "",
	"approvalTime": "",
	"dataId": 0,
	"dataType": "",
	"delFlag": "",
	"tenantId": 0
}

删除数据审核

接口地址:/museum/dataApproval/{approvalId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
approvalId	approvalId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

数据推荐关联

新增保存数据推荐关联

接口地址:/museum/dataRecommendRel/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "recommendId": 0,
  "recommendType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	DataRecommendRelAddDto	DataRecommendRelAddDto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
recommendId	推荐数据ID		false	integer(int64)
recommendType	推荐数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改保存数据推荐关联

接口地址:/museum/dataRecommendRel/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "recommendId": 0,
  "recommendType": "",
  "relId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	DataRecommendRelEditDto	DataRecommendRelEditDto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
recommendId	推荐数据ID		false	integer(int64)
recommendType	推荐数据类型		false	string
relId	关联ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据数据类型获取数据名称列表

接口地址:/museum/dataRecommendRel/getRecommendDataList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	数据类型(3：展厅，4：藏品，5：文章，6：展览，12：视频)	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询数据推荐关联列表

接口地址:/museum/dataRecommendRel/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createEnd	结束时间：开始日期 yyyy-MM-dd HH:mm:ss	query	false	string
createStart	开始时间：开始日期 yyyy-MM-dd HH:mm:ss	query	false	string
dataType	数据类型	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PageInfo«DataRecommendRelVoList»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
endRow		integer(int64)	integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	DataRecommendRelVoList
createBy	创建者	string
createTime	创建时间	string(date-time)
dataId	数据ID	integer(int64)
dataType	数据类型	string
delFlag	删除标志;（0：未删除，1：已删除）	string
recommendId	推荐数据ID	integer(int64)
recommendType	推荐数据类型	string
relId	关联ID	integer(int64)
tenantId	租户ID	integer(int64)
navigateFirstPage		integer(int32)	integer(int32)
navigateLastPage		integer(int32)	integer(int32)
navigatePages		integer(int32)	integer(int32)
navigatepageNums		array
nextPage		integer(int32)	integer(int32)
pageNum		integer(int32)	integer(int32)
pageSize		integer(int32)	integer(int32)
pages		integer(int32)	integer(int32)
prePage		integer(int32)	integer(int32)
size		integer(int32)	integer(int32)
startRow		integer(int64)	integer(int64)
total		integer(int64)	integer(int64)

响应示例:

{
	"endRow": 0,
	"hasNextPage": true,
	"hasPreviousPage": true,
	"isFirstPage": true,
	"isLastPage": true,
	"list": [
		{
			"createBy": "",
			"createTime": "",
			"dataId": 0,
			"dataType": "",
			"delFlag": "",
			"recommendId": 0,
			"recommendType": "",
			"relId": 0,
			"tenantId": 0
		}
	],
	"navigateFirstPage": 0,
	"navigateLastPage": 0,
	"navigatePages": 0,
	"navigatepageNums": [],
	"nextPage": 0,
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"prePage": 0,
	"size": 0,
	"startRow": 0,
	"total": 0
}

查询数据文件关联详情

接口地址:/museum/dataRecommendRel/{relId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	DataRecommendRelDetailsVo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
createBy	创建者	string
createTime	创建时间	string(date-time)	string(date-time)
dataId	数据ID	integer(int64)	integer(int64)
dataType	数据类型	string
delFlag	删除标志;（0：未删除，1：已删除）	string
recommendId	推荐数据ID	integer(int64)	integer(int64)
recommendType	推荐数据类型	string
relId	关联ID	integer(int64)	integer(int64)
tenantId	租户ID	integer(int64)	integer(int64)

响应示例:

{
	"createBy": "",
	"createTime": "",
	"dataId": 0,
	"dataType": "",
	"delFlag": "",
	"recommendId": 0,
	"recommendType": "",
	"relId": 0,
	"tenantId": 0
}

删除数据文件关联

接口地址:/museum/dataRecommendRel/{relId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

数据文件关联

新增保存数据文件关联

接口地址:/museum/dataFileRel/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "fileId": 0,
  "fileType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	DataFileRelAddDto	DataFileRelAddDto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
fileId	文件ID		false	integer(int64)
fileType	文件类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改保存数据文件关联

接口地址:/museum/dataFileRel/edit

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "dataId": 0,
  "dataType": "",
  "fileId": 0,
  "fileType": "",
  "relId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	DataFileRelEditDto	DataFileRelEditDto
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
fileId	文件ID		false	integer(int64)
fileType	文件类型		false	string
relId	关联ID		false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询数据文件关联列表

接口地址:/museum/dataFileRel/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	query	false	integer(int64)
fileType	fileType	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PageInfo«关联文件详情Vo»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
endRow		integer(int64)	integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	关联文件详情Vo
fileDesc	关联文件简介	string
fileId	关联文件ID	string
fileName	关联文件名称	string
fileType	关联文件类型（1：图片，2：视频，3：音频，4：模型）	string
fileUrl	关联文件路径	string
videoAndModelFileCover	视频、模型文件封面	封面文件详情Vo	封面文件详情Vo
fileId	封面文件ID	string
fileName	封面文件名称	string
fileUrl	封面文件路径	string
navigateFirstPage		integer(int32)	integer(int32)
navigateLastPage		integer(int32)	integer(int32)
navigatePages		integer(int32)	integer(int32)
navigatepageNums		array
nextPage		integer(int32)	integer(int32)
pageNum		integer(int32)	integer(int32)
pageSize		integer(int32)	integer(int32)
pages		integer(int32)	integer(int32)
prePage		integer(int32)	integer(int32)
size		integer(int32)	integer(int32)
startRow		integer(int64)	integer(int64)
total		integer(int64)	integer(int64)

响应示例:

{
	"endRow": 0,
	"hasNextPage": true,
	"hasPreviousPage": true,
	"isFirstPage": true,
	"isLastPage": true,
	"list": [
		{
			"fileDesc": "",
			"fileId": "",
			"fileName": "",
			"fileType": 1,
			"fileUrl": "",
			"videoAndModelFileCover": {
				"fileId": "",
				"fileName": "",
				"fileUrl": ""
			}
		}
	],
	"navigateFirstPage": 0,
	"navigateLastPage": 0,
	"navigatePages": 0,
	"navigatepageNums": [],
	"nextPage": 0,
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"prePage": 0,
	"size": 0,
	"startRow": 0,
	"total": 0
}

查询数据文件关联详情

接口地址:/museum/dataFileRel/{relId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	DataFileRelDetailsVo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
createBy	创建者	string
createTime	创建时间	string(date-time)	string(date-time)
dataId	数据ID	integer(int64)	integer(int64)
dataType	数据类型	string
delFlag	删除标志;（0：未删除，1：已删除）	string
fileId	文件ID	integer(int64)	integer(int64)
fileName	文件名称	string
fileType	文件类型	string
relId	关联ID	integer(int64)	integer(int64)
tenantId	租户ID	integer(int64)	integer(int64)

响应示例:

{
	"createBy": "",
	"createTime": "",
	"dataId": 0,
	"dataType": "",
	"delFlag": "",
	"fileId": 0,
	"fileName": "",
	"fileType": "",
	"relId": 0,
	"tenantId": 0
}

删除数据文件关联

接口地址:/museum/dataFileRel/{relId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
relId	relId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

文章管理

新增文章

接口地址:/museum/museumArticle

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "articleContent": "",
  "articleDesc": "",
  "articleModule": 1,
  "articleName": "",
  "coverFile": {
    "fileId": 0
  },
  "isComment": 1,
  "isPraise": 1,
  "isTop": 0,
  "relDataList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "relFileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "saveOrSubmit": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumArticleAddDto	museumArticleAddDto	body	true	新增文章Dto	新增文章Dto
articleContent	文章内容		false	string
articleDesc	文章简介		false	string
articleModule	所属模块（1：展馆动态，2：精品文章，3：展馆概况，4：用户服务协议，5：隐私政策）		false	string
articleName	文章名称		false	string
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
isComment	是否允许评论;（0：否，1：是）		false	string
isPraise	是否允许点赞;（0：否，1：是）		false	string
isTop	是否置顶;（0：否，1：是）		false	string
relDataList	推荐内容列表		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
relFileList	关联文件列表（不包含封面图片）		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
saveOrSubmit	操作（1：保存，2：提交）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改文章

接口地址:/museum/museumArticle

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "articleContent": "",
  "articleDesc": "",
  "articleId": 0,
  "articleModule": 1,
  "articleName": "",
  "coverFile": {
    "fileId": 0
  },
  "isComment": 1,
  "isPraise": 1,
  "isTop": 0,
  "relDataList": [
    {
      "recommendId": 0,
      "recommendType": ""
    }
  ],
  "relFileList": [
    {
      "fileId": 0,
      "fileType": 1
    }
  ],
  "saveOrSubmit": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumArticleEditDto	museumArticleEditDto	body	true	修改文章Dto	修改文章Dto
articleContent	文章内容		false	string
articleDesc	文章简介		false	string
articleId	文章ID		true	integer(int64)
articleModule	所属模块（1：展馆动态，2：精品文章，3：展馆概况，4：用户服务协议，5：隐私政策）		false	string
articleName	文章名称		false	string
coverFile	封面文件		false	封面文件新增及修改Dto	封面文件新增及修改Dto
fileId	封面文件ID		false	integer
isComment	是否允许评论;（0：否，1：是）		false	string
isPraise	是否允许点赞;（0：否，1：是）		false	string
isTop	是否置顶;（0：否，1：是）		false	string
relDataList	推荐内容列表		false	array	推荐数据新增或修改Dto
recommendId	推荐数据ID		false	integer
recommendType	推荐数据类型		false	string
relFileList	关联文件列表（不包含封面图片）		false	array	楼层、展厅、藏品、文章新增或修改多媒体文件Dto
fileId	文件ID		true	integer
fileType	文件类型（1：图片，2：视频，3：音频，4：模型）		true	string
saveOrSubmit	操作（1：保存，2：提交）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

文章审核

接口地址:/museum/museumArticle/approve

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approveOpinion": "",
  "approveStatus": "",
  "articleId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumArticleApproveDto	museumArticleApproveDto	body	true	文章审核Dto	文章审核Dto
approveOpinion	审核意见		false	string
approveStatus	审核操作（1：通过，2：驳回）		true	string
articleId	文章ID		true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出查询文章列表

接口地址:/museum/museumArticle/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
articleModule	所属模块（1：展馆动态，2：精品文章，3：展馆概况，4：用户服务协议，5：隐私政策）	query	false	string
articleName	文章名称	query	false	string
articleStatus	文章状态;（0：待审核，1：已上架，2：已下架，4：已驳回，9：草稿）	query	false	array	string
createBy	发布者名称	query	false	string
isTop	是否置顶;（0：否，1：是）	query	false	string
onlineBeginTime	发布开始时间	query	false	string(date)
onlineEndTime	发布结束时间	query	false	string(date)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
updateBeginTime	编辑开始时间	query	false	string(date)
updateEndTime	编辑结束时间	query	false	string(date)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询文章列表

接口地址:/museum/museumArticle/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
articleModule	所属模块（1：展馆动态，2：精品文章，3：展馆概况，4：用户服务协议，5：隐私政策）	query	false	string
articleName	文章名称	query	false	string
articleStatus	文章状态;（0：待审核，1：已上架，2：已下架，4：已驳回，9：草稿）	query	false	array	string
createBy	发布者名称	query	false	string
isTop	是否置顶;（0：否，1：是）	query	false	string
onlineBeginTime	发布开始时间	query	false	string(date)
onlineEndTime	发布结束时间	query	false	string(date)
pageNum	分页参数	query	false	integer(int32)
pageSize	分页参数	query	false	integer(int32)
tenant_id	租户ID	header	false	integer(int64)
updateBeginTime	编辑开始时间	query	false	string(date)
updateEndTime	编辑结束时间	query	false	string(date)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

文章下架

接口地址:/museum/museumArticle/offline/{articleId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleId	articleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

文章置顶与取消置顶

接口地址:/museum/museumArticle/toTop

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "articleId": 0,
  "isTop": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
museumArticleToTopDto	museumArticleToTopDto	body	true	文章置顶与取消Dto	文章置顶与取消Dto
articleId	文章ID		true	integer(int64)
isTop	置顶操作（1：置顶，2：取消置顶）		true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除文章

接口地址:/museum/museumArticle/{articleIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleIds	articleIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

获取文章详细信息

接口地址:/museum/museumArticle/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
articleId	articleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

消息推送

筛选用户推送列表

接口地址:/museum/message/push/pushList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
activeStatus		query	false	string
articleName	文章名称(100)	query	false	string
createEnd	注册时间：结束日期(10)	query	false	string
createStart	注册时间：开始日期(10)	query	false	string
dataType	数据类型: 4：藏品 5：文章 6：展览	query	false	string
databaseAlias	数据库别名	query	false	string
exhibitType	藏品类型(10)	query	false	string
exhibitionName	展览名称(100)	query	false	string
pushTag	推送标签	query	false	string
reserveType	预约类型(10)	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userAddress		query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

对用户消息进行推送

接口地址:/museum/message/push/pushMessage

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
activeStatus		query	false	string
articleName	文章名称(100)	query	false	string
completeNum	已推送人数	query	false	integer(int32)
createEnd	注册时间：结束日期(10)	query	false	string
createStart	注册时间：开始日期(10)	query	false	string
dataType	数据类型: 4：藏品 5：文章 6：展览	query	false	string
databaseAlias	数据库别名	query	false	string
exhibitType	藏品类型(10)	query	false	string
exhibitionName	展览名称(100)	query	false	string
messageContent	消息模板内容	query	false	string
messageType	消息模板类型，1：验证码，2：短信通知，3：推广短信	query	false	string
planTime	预定计划时间	query	false	string(date-time)
pushId	消息推送ID	query	false	integer(int64)
pushNum	人数	query	false	integer(int32)
pushTag	推送标签	query	false	string
pushType	推送类型,1:立即推送,2:定时推送	query	false	string
reserveType	预约类型(10)	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userAddress		query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户收藏

查询收藏列表

接口地址:/museum/dataCollection/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
collectionBy	收藏人	query	false	string
dataName	收藏名称	query	false	string
dataType	收藏类型 4:藏品,5:文章,6:展览	query	false	string
reqType	请求类型{0：后台，1：前台}	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

用户联系人

根据用户id查询注册用户联系人

接口地址:/museum/userContact/getContactList/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userId	userId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户联系人-前台

删除联系人

接口地址:/museum/front/userContact/delete/{ids}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
ids	ids	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

查询注册用户联系人列表

接口地址:/museum/front/userContact/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据身份证获取购票类型

接口地址:/museum/front/userContact/noLogin/getTickerTYpe

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
cardNo	cardNo	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改联系人信息

接口地址:/museum/front/userContact/update

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "contactCardNo": "",
  "contactCardType": "",
  "contactId": 0,
  "contactName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	UpdateContactDto	UpdateContactDto
contactCardNo	联系人证件号码		false	string
contactCardType	联系人证件类型(0:居民身份证，1:港澳台通行证)		false	string
contactId	联系人Id		false	integer(int64)
contactName	联系人姓名		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

统计分析

查询注册用户统计

接口地址:/museum/analysis/countRegisteredUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
timeType	timeType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询浏览量统计

接口地址:/museum/analysis/countViewNum

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	dataType	query	true	string
timeType	timeType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询数据分类饼图

接口地址:/museum/analysis/dataTypePie

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	dataType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询预约详情

接口地址:/museum/analysis/reserveDetail

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约趋势

接口地址:/museum/analysis/reserveTrend

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
timeType	timeType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询浏览量TOP10

接口地址:/museum/analysis/viewNumTop

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataType	dataType	query	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

评论管理

批量评论审核

接口地址:/museum/dataComment/approves

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approveStatus": "",
  "commentId": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dataCommentApprovalDTO	dataCommentApprovalDTO	body	true	评论审核dto	评论审核dto
approvalDesc	审核描述		false	string
approveStatus	审核操作（0：初始，1：通过，2：驳回）		false	string
commentId	评论ID		false	array	integer
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询文章藏品详情

接口地址:/museum/dataComment/detail/{commentId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
commentId	commentId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

评论管理

接口地址:/museum/dataComment/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
commentBy	评论人	query	false	string
commentContent	评论内容	query	false	string
commentStatus	评论状态 0初始，1通过，2不通过	query	false	string
dataType	数据类型 4:藏品,5:文章	query	false	string
databaseAlias	数据库别名	query	false	string
endTime	结束时间	query	false	string
startTime	开始时间	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询文章藏品评论

接口地址:/museum/dataComment/list/{dataId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dataId	dataId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

统计今日评论数量

接口地址:/museum/dataComment/number

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

页面模板配置管理

新增页面模板配置

接口地址:/museum/pageModel

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "modelDesc": "",
  "modelId": 0,
  "modelName": "",
  "modelStatus": "",
  "tenantId": 0,
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
pageModel	页面模板配置表	body	true	PageModel对象	PageModel对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志;（0：未删除，1：已删除）		false	string
modelDesc	页面模板描述		false	string
modelId	页面模板ID		false	integer(int64)
modelName	页面模板名称		false	string
modelStatus	页面模板状态;（0：未应用，1：已应用）		false	string
tenantId	租户ID		false	integer(int64)
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改页面模板配置

接口地址:/museum/pageModel

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "modelDesc": "",
  "modelId": 0,
  "modelName": "",
  "modelStatus": "",
  "tenantId": 0,
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
pageModel	页面模板配置表	body	true	PageModel对象	PageModel对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志;（0：未删除，1：已删除）		false	string
modelDesc	页面模板描述		false	string
modelId	页面模板ID		false	integer(int64)
modelName	页面模板名称		false	string
modelStatus	页面模板状态;（0：未应用，1：已应用）		false	string
tenantId	租户ID		false	integer(int64)
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出页面模板配置查询列表

接口地址:/museum/pageModel/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
modelName	页面模板名称	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询页面模板配置列表

接口地址:/museum/pageModel/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
modelName	页面模板名称	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除页面模板配置

接口地址:/museum/pageModel/{modelIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
modelIds	modelIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

获取页面模板配置详细信息

接口地址:/museum/pageModel/{modelId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
modelId	modelId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

预约要素

新增预约（线下）

接口地址:/museum/reserve/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "exhibitionId": 0,
  "isPay": "",
  "reserveChannel": "",
  "reserveCompany": "",
  "reserveDate": "",
  "reserveNum": 0,
  "reserveReason": "",
  "userCardNo": "",
  "userPhone": "",
  "userRealName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
baseAddDTO	baseAddDTO	body	true	BaseAddDto	BaseAddDto
exhibitionId	展览ID		false	integer(int64)
isPay	是否购票;（0：否，1：是）		false	string
reserveChannel	预约渠道		false	string
reserveCompany	预约单位		false	string
reserveDate	预约时间		false	string(date)
reserveNum	预约人数		false	integer(int32)
reserveReason	预约原因		false	string
userCardNo	用户身份证号码		false	string
userPhone	用户手机号		false	string
userRealName	用户真实名称		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

退订审核

接口地址:/museum/reserve/baseApproval

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "approvalDesc": "",
  "approvalStatus": "",
  "dataId": 0,
  "dataType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
addDto	addDto	body	true	DataApprovalAddDto	DataApprovalAddDto
approvalDesc	审核描述		false	string
approvalStatus	审核状态;（0：初始，1：通过，2：不通过）		false	string
dataId	数据ID		false	integer(int64)
dataType	数据类型		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

取消预约

接口地址:/museum/reserve/cancle/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

核销

接口地址:/museum/reserve/check/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除预约

接口地址:/museum/reserve/delete

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
ids	ids	query	false	array	integer
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

修改预约（线下）

接口地址:/museum/reserve/edit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "reserveDate": "",
  "reserveId": 0,
  "userCardNo": "",
  "userCardType": "",
  "userName": "",
  "userPhone": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
orderUpdateDto	orderUpdateDto	body	true	OrderUpdateDto	OrderUpdateDto
reserveDate	预约时间		false	string(date-time)
reserveId	预约ID		false	integer(int64)
userCardNo	用户身份证号码		false	string
userCardType	用户证件类型		false	string
userName	用户名称		false	string
userPhone	用户手机号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

统计预约及核销人数

接口地址:/museum/reserve/getNum

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据日期查询余票

接口地址:/museum/reserve/getTicketNum/{exhibitionId}/{nowDate}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitionId	exhibitionId	path	true	integer(int64)
nowDate	nowDate	path	true	string(date)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

退订

接口地址:/museum/reserve/optOut

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
ids	ids	query	true	array	integer
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约详情

接口地址:/museum/reserve/query/getBaseInfo/{reserveId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约列表

接口地址:/museum/reserve/query/getReserveList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createTimeEnd	预约时间止	query	false	string(date-time)
createTimeStart	预约时间起	query	false	string(date-time)
exhibitionName	展览名称	query	false	string
isReturn	退订状态;（0：否，1：是 9：退款申请驳回 )	query	false	string
reqType	请求类型{0：后台，1：移动端}	query	false	string
reserveChannel	预约渠道{2:线上 1：线下}	query	false	string
reserveDateEnd	参观时间止	query	false	string(date-time)
reserveDateStart	参观时间起	query	false	string(date-time)
reserveNumEnd	预约人数范围止	query	false	integer(int32)
reserveNumStart	预约人数范围起	query	false	integer(int32)
reserveStatus	预约状态	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userPhone	用户手机号	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

预约要素-前台

新增预约（线上）

接口地址:/museum/front/reserve/addOrder

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "contacts": [
    {
      "contactCardNo": "",
      "contactCardType": "",
      "contactName": "",
      "reserveId": 0,
      "tickerType": "",
      "ticketPrice": 0
    }
  ],
  "exhibitionId": 0,
  "payType": "",
  "reserveDate": "",
  "totalAmout": 0,
  "userPhone": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
orderAddDTO	orderAddDTO	body	true	OrderAddDto	OrderAddDto
contacts	用户预约联系人		false	array	ContactAddDto
contactCardNo	联系人证件号码		false	string
contactCardType	联系人证件类型		false	string
contactName	联系人姓名		false	string
reserveId	预约ID		false	integer
tickerType	门票类型		false	string
ticketPrice	门票价格		false	number
exhibitionId	展览ID		false	integer(int64)
payType	购票方式{1:线上购买 2：现场购买 }		false	string
reserveDate	参观日期		false	string(date-time)
totalAmout	预约单金额		false	number
userPhone	用户手机号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

取消预约

接口地址:/museum/front/reserve/cancel/{reserveId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

退订申请

接口地址:/museum/front/reserve/cancelApply/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

取消退订申请

接口地址:/museum/front/reserve/noCancelApply/{reserveId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取预约周期内余票

接口地址:/museum/front/reserve/noLogin/getOrderNum/{exhibitionId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
exhibitionId	exhibitionId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约详情

接口地址:/museum/front/reserve/query/getBaseInfo/{reserveId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
reserveId	reserveId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询预约列表

接口地址:/museum/front/reserve/query/getReserveList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createTimeEnd	预约时间止	query	false	string(date-time)
createTimeStart	预约时间起	query	false	string(date-time)
exhibitionName	展览名称	query	false	string
isReturn	退订状态;（0：否，1：是 9：退款申请驳回 )	query	false	string
reqType	请求类型{0：后台，1：移动端}	query	false	string
reserveChannel	预约渠道{2:线上 1：线下}	query	false	string
reserveDateEnd	参观时间止	query	false	string(date-time)
reserveDateStart	参观时间起	query	false	string(date-time)
reserveNumEnd	预约人数范围止	query	false	integer(int32)
reserveNumStart	预约人数范围起	query	false	integer(int32)
reserveStatus	预约状态	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userPhone	用户手机号	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

系统模块接口文档

简介:系统模块接口文档

HOST:xxxx.xxxx.xxx

联系人:

Version:

接口路径:/system/v2/api-docs

[TOC]

平台-个人信息

获取个人信息

接口地址:/system/user/profile

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改个人信息

接口地址:/system/user/profile

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	SysUser对象	SysUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	SysDept对象	SysDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	SysDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户头像上传

接口地址:/system/user/profile/avatar

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
avatarfile	avatarfile	formData	true	file
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

个人信息重置密码

接口地址:/system/user/profile/updatePwd

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
newPassword	newPassword	query	false	string
oldPassword	oldPassword	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-公告

新增通知公告

接口地址:/system/notice

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "fileName": "",
  "fileUrl": "",
  "noticeContent": "",
  "noticeId": "",
  "noticeTitle": "",
  "noticeType": "",
  "releaseMechanism": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
notice	通知公告表	body	true	SysNotice对象	SysNotice对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）		false	string
fileName	附件名称		false	string
fileUrl	附件地址		false	string
noticeContent	公告内容		false	string
noticeId	公告ID		false	string
noticeTitle	公告标题		false	string
noticeType	公告类型（1：通知，2：公告）		false	string
releaseMechanism	发布机构		false	string
remark	备注		false	string
status	公告状态（0：正常，1：关闭）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改通知公告

接口地址:/system/notice

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "fileName": "",
  "fileUrl": "",
  "noticeContent": "",
  "noticeId": "",
  "noticeTitle": "",
  "noticeType": "",
  "releaseMechanism": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
notice	通知公告表	body	true	SysNotice对象	SysNotice对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）		false	string
fileName	附件名称		false	string
fileUrl	附件地址		false	string
noticeContent	公告内容		false	string
noticeId	公告ID		false	string
noticeTitle	公告标题		false	string
noticeType	公告类型（1：通知，2：公告）		false	string
releaseMechanism	发布机构		false	string
remark	备注		false	string
status	公告状态（0：正常，1：关闭）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除通知公告

接口地址:/system/notice/delete/{noticeId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

管理端-获取通知公告列表

接口地址:/system/notice/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）	query	false	string
fileName	附件名称	query	false	string
fileUrl	附件地址	query	false	string
noticeContent	公告内容	query	false	string
noticeId	公告ID	query	false	integer(int64)
noticeTitle	公告标题	query	false	string
noticeType	公告类型（1：通知，2：公告）	query	false	string
releaseMechanism	发布机构	query	false	string
remark	备注	query	false	string
status	公告状态（0：正常，1：关闭）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

下线通知公告

接口地址:/system/notice/offlineNotice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

上线通知公告

接口地址:/system/notice/onlineNotice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

管理端-根据通知公告编号获取详细信息

接口地址:/system/notice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-公告-门户

门户-获取通知公告列表

接口地址:/system/front/notice/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）	query	false	string
fileName	附件名称	query	false	string
fileUrl	附件地址	query	false	string
noticeContent	公告内容	query	false	string
noticeId	公告ID	query	false	integer(int64)
noticeTitle	公告标题	query	false	string
noticeType	公告类型（1：通知，2：公告）	query	false	string
releaseMechanism	发布机构	query	false	string
remark	备注	query	false	string
status	公告状态（0：正常，1：关闭）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

门户-根据通知公告编号获取详细信息

接口地址:/system/front/notice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-参数配置

新增参数配置

接口地址:/system/config

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "configId": "",
  "configKey": "",
  "configName": "",
  "configType": "",
  "configValue": "",
  "createBy": "",
  "createTime": "",
  "remark": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
config	参数配置表	body	true	SysConfig对象	SysConfig对象
configId	参数主键		false	string
configKey	参数键名		false	string
configName	参数名称		false	string
configType	系统内置（Y是 N否）		false	string
configValue	参数键值		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
remark	备注		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改参数配置

接口地址:/system/config

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "configId": "",
  "configKey": "",
  "configName": "",
  "configType": "",
  "configValue": "",
  "createBy": "",
  "createTime": "",
  "remark": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
config	参数配置表	body	true	SysConfig对象	SysConfig对象
configId	参数主键		false	string
configKey	参数键名		false	string
configName	参数名称		false	string
configType	系统内置（Y是 N否）		false	string
configValue	参数键值		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
remark	备注		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据参数键名查询参数值

接口地址:/system/config/configKey/{configKey}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
configKey	configKey	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出参数管理列表

接口地址:/system/config/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
configId	参数主键	query	false	integer(int64)
configKey	参数键名	query	false	string
configName	参数名称	query	false	string
configType	系统内置（Y是 N否）	query	false	string
configValue	参数键值	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
params	请求参数	query	false	object
remark	备注	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询参数管理列表

接口地址:/system/config/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
configId	参数主键	query	false	integer(int64)
configKey	参数键名	query	false	string
configName	参数名称	query	false	string
configType	系统内置（Y是 N否）	query	false	string
configValue	参数键值	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
params	请求参数	query	false	object
remark	备注	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

刷新参数缓存

接口地址:/system/config/refreshCache

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

删除参数配置

接口地址:/system/config/{configIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
configIds	configIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据参数编号获取详细信息

接口地址:/system/config/{configId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
configId	configId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-在线用户监控

查询在线用户列表

接口地址:/system/online/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
ipaddr	ipaddr	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userName	userName	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

强退用户

接口地址:/system/online/{tokenId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tokenId	tokenId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

平台-字典数据

新增字典类型

接口地址:/system/dict/data

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "cssClass": "",
  "default": true,
  "dictCode": "",
  "dictLabel": "",
  "dictSort": 0,
  "dictType": "",
  "dictValue": "",
  "isDefault": "",
  "listClass": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dict	字典数据表	body	true	SysDictData对象	SysDictData对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
cssClass	样式属性（其他样式扩展）		false	string
default			false	boolean
dictCode	字典编码		false	string
dictLabel	字典标签		false	string
dictSort	字典排序		false	integer(int64)
dictType	字典类型		false	string
dictValue	字典键值		false	string
isDefault	是否默认（Y是 N否）		false	string
listClass	表格字典样式		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改保存字典类型

接口地址:/system/dict/data

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "cssClass": "",
  "default": true,
  "dictCode": "",
  "dictLabel": "",
  "dictSort": 0,
  "dictType": "",
  "dictValue": "",
  "isDefault": "",
  "listClass": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dict	字典数据表	body	true	SysDictData对象	SysDictData对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
cssClass	样式属性（其他样式扩展）		false	string
default			false	boolean
dictCode	字典编码		false	string
dictLabel	字典标签		false	string
dictSort	字典排序		false	integer(int64)
dictType	字典类型		false	string
dictValue	字典键值		false	string
isDefault	是否默认（Y是 N否）		false	string
listClass	表格字典样式		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出字典数据列表

接口地址:/system/dict/data/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
cssClass	样式属性（其他样式扩展）	query	false	string
default		query	false	boolean
dictCode	字典编码	query	false	integer(int64)
dictLabel	字典标签	query	false	string
dictSort	字典排序	query	false	integer(int64)
dictType	字典类型	query	false	string
dictValue	字典键值	query	false	string
isDefault	是否默认（Y是 N否）	query	false	string
listClass	表格字典样式	query	false	string
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询字典数据列表

接口地址:/system/dict/data/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
cssClass	样式属性（其他样式扩展）	query	false	string
default		query	false	boolean
dictCode	字典编码	query	false	integer(int64)
dictLabel	字典标签	query	false	string
dictSort	字典排序	query	false	integer(int64)
dictType	字典类型	query	false	string
dictValue	字典键值	query	false	string
isDefault	是否默认（Y是 N否）	query	false	string
listClass	表格字典样式	query	false	string
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

根据字典类型查询字典数据信息

接口地址:/system/dict/data/type/{dictType}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dictType	dictType	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除字典类型

接口地址:/system/dict/data/{dictCodes}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dictCodes	dictCodes	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

查询字典数据详细

接口地址:/system/dict/data/{dictCode}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dictCode	dictCode	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-字典类型

新增字典类型

接口地址:/system/dict/type

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "dictId": "",
  "dictName": "",
  "dictType": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dict	字典类型表	body	true	SysDictType对象	SysDictType对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dictId	字典主键		false	string
dictName	字典名称		false	string
dictType	字典类型		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改字典类型

接口地址:/system/dict/type

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "dictId": "",
  "dictName": "",
  "dictType": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dict	字典类型表	body	true	SysDictType对象	SysDictType对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dictId	字典主键		false	string
dictName	字典名称		false	string
dictType	字典类型		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出字典类型列表

接口地址:/system/dict/type/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
dictId	字典主键	query	false	integer(int64)
dictName	字典名称	query	false	string
dictType	字典类型	query	false	string
params	请求参数	query	false	object
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询字典类型列表

接口地址:/system/dict/type/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
dictId	字典主键	query	false	integer(int64)
dictName	字典名称	query	false	string
dictType	字典类型	query	false	string
params	请求参数	query	false	object
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取字典选择框列表

接口地址:/system/dict/type/optionselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

刷新字典缓存

接口地址:/system/dict/type/refreshCache

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

删除字典类型

接口地址:/system/dict/type/{dictIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dictIds	dictIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

查询字典类型详细

接口地址:/system/dict/type/{dictId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
dictId	dictId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-岗位

新增岗位

接口地址:/system/post

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "flag": true,
  "postCode": "",
  "postId": "",
  "postName": "",
  "postSort": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
post	岗位表	body	true	SysPost对象	SysPost对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
flag	用户是否存在此岗位标识默认不存在		false	boolean
postCode	岗位编码		false	string
postId	岗位序号		false	string
postName	岗位名称		false	string
postSort	岗位排序		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改岗位

接口地址:/system/post

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "flag": true,
  "postCode": "",
  "postId": "",
  "postName": "",
  "postSort": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
post	岗位表	body	true	SysPost对象	SysPost对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
flag	用户是否存在此岗位标识默认不存在		false	boolean
postCode	岗位编码		false	string
postId	岗位序号		false	string
postName	岗位名称		false	string
postSort	岗位排序		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出岗位列表

接口地址:/system/post/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
flag	用户是否存在此岗位标识默认不存在	query	false	boolean
postCode	岗位编码	query	false	string
postId	岗位序号	query	false	integer(int64)
postName	岗位名称	query	false	string
postSort	岗位排序	query	false	string
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取岗位列表

接口地址:/system/post/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
flag	用户是否存在此岗位标识默认不存在	query	false	boolean
postCode	岗位编码	query	false	string
postId	岗位序号	query	false	integer(int64)
postName	岗位名称	query	false	string
postSort	岗位排序	query	false	string
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取岗位选择框列表

接口地址:/system/post/optionselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除岗位

接口地址:/system/post/{postIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
postIds	postIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据岗位编号获取详细信息

接口地址:/system/post/{postId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
postId	postId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-日志

add

接口地址:/system/operlog

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "businessType": "",
  "businessTypes": [],
  "deptName": "",
  "errorMsg": "",
  "jsonResult": "",
  "method": "",
  "operId": "",
  "operIp": "",
  "operLocation": "",
  "operName": "",
  "operParam": "",
  "operTime": "",
  "operUrl": "",
  "operatorType": "",
  "requestMethod": "",
  "status": "",
  "title": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
operLog	操作日志记录表	body	true	SysOperLog对象	SysOperLog对象
businessType	业务类型（0：其它，1：新增， 2：修改，3：删除，4：授权，5：导出，6：导入，7：强退，8：生成代码，9：清空数据）		false	string
businessTypes	业务类型数组		false	array	string
deptName	部门名称		false	string
errorMsg	错误消息		false	string
jsonResult	返回参数		false	string
method	请求方法		false	string
operId	日志主键		false	string
operIp	操作地址		false	string
operLocation	操作地点		false	string
operName	操作人员		false	string
operParam	请求参数		false	string
operTime	操作时间		false	string(date-time)
operUrl	请求URL		false	string
operatorType	操作类别（0：其它，1：后台用户，2：手机端用户）		false	string
requestMethod	请求方式		false	string
status	操作状态（0：正常，1：异常）		false	string
title	操作模块		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

清除日志

接口地址:/system/operlog/clean

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

导出日志

接口地址:/system/operlog/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
businessType	业务类型（0：其它，1：新增， 2：修改，3：删除，4：授权，5：导出，6：导入，7：强退，8：生成代码，9：清空数据）	query	false	string
businessTypes	业务类型数组	query	false	array	string
deptName	部门名称	query	false	string
errorMsg	错误消息	query	false	string
jsonResult	返回参数	query	false	string
method	请求方法	query	false	string
operId	日志主键	query	false	integer(int64)
operIp	操作地址	query	false	string
operLocation	操作地点	query	false	string
operName	操作人员	query	false	string
operParam	请求参数	query	false	string
operTime	操作时间	query	false	string(date-time)
operUrl	请求URL	query	false	string
operatorType	操作类别（0：其它，1：后台用户，2：手机端用户）	query	false	string
params	请求参数	query	false	object
requestMethod	请求方式	query	false	string
status	操作状态（0：正常，1：异常）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
title	操作模块	query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

日志列表

接口地址:/system/operlog/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
businessType	业务类型（0：其它，1：新增， 2：修改，3：删除，4：授权，5：导出，6：导入，7：强退，8：生成代码，9：清空数据）	query	false	string
businessTypes	业务类型数组	query	false	array	string
deptName	部门名称	query	false	string
errorMsg	错误消息	query	false	string
jsonResult	返回参数	query	false	string
method	请求方法	query	false	string
operId	日志主键	query	false	integer(int64)
operIp	操作地址	query	false	string
operLocation	操作地点	query	false	string
operName	操作人员	query	false	string
operParam	请求参数	query	false	string
operTime	操作时间	query	false	string(date-time)
operUrl	请求URL	query	false	string
operatorType	操作类别（0：其它，1：后台用户，2：手机端用户）	query	false	string
params	请求参数	query	false	object
requestMethod	请求方式	query	false	string
status	操作状态（0：正常，1：异常）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
title	操作模块	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除日志

接口地址:/system/operlog/{operIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
operIds	operIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

平台-用户

新增用户

接口地址:/system/user

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	SysUser对象	SysUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	SysDept对象	SysDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	SysDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改用户

接口地址:/system/user

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	SysUser对象	SysUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	SysDept对象	SysDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	SysDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据用户编号获取详细信息

接口地址:/system/user/

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)
userId	userId	path	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户授权角色

接口地址:/system/user/authRole

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
roleIds	roleIds	query	false	array	integer
tenant_id	租户ID	header	false	integer(int64)
userId	userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据用户编号获取授权角色

接口地址:/system/user/authRole/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userId	userId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户状态修改

接口地址:/system/user/changeStatus/{id}/{status}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
id	id	path	true	integer(int64)
status	status	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出用户列表

接口地址:/system/user/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取用户信息

接口地址:/system/user/getInfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取当前用户信息

接口地址:/system/user/getSysUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«SysUser对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		SysUser对象	SysUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	SysDept对象	SysDept对象
ancestors	祖级列表	string
children	子部门	array	SysDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string(date-time)
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	SysRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
updateBy	更新人	string
updateTime	更新时间	string(date-time)
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
msg		string

响应示例:

{
	"code": 0,
	"data": {
		"admin": true,
		"avatar": "",
		"createBy": "",
		"createTime": "",
		"delFlag": "",
		"dept": {
			"ancestors": "",
			"children": [
				{
					"ancestors": "",
					"children": [
						{}
					],
					"createBy": "",
					"createTime": "",
					"delFlag": "",
					"deptId": "",
					"deptName": "",
					"deptType": "",
					"email": "",
					"leader": "",
					"orderNum": "",
					"parentId": "",
					"parentName": "",
					"phone": "",
					"status": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"deptId": "",
			"deptName": "",
			"deptType": "",
			"email": "",
			"leader": "",
			"orderNum": "",
			"parentId": "",
			"parentName": "",
			"phone": "",
			"status": "",
			"updateBy": "",
			"updateTime": ""
		},
		"deptId": "",
		"email": "",
		"loginDate": "",
		"loginIp": "",
		"nickName": "",
		"password": "",
		"phonenumber": "",
		"postIds": "",
		"remark": "",
		"roleId": "",
		"roleIds": "",
		"roles": [
			{
				"admin": true,
				"createBy": "",
				"createTime": "",
				"dataScope": "",
				"delFlag": "",
				"deptCheckStrictly": true,
				"deptIds": "",
				"flag": true,
				"menuCheckStrictly": true,
				"menuIds": "",
				"remark": "",
				"roleId": "",
				"roleKey": "",
				"roleName": "",
				"roleSort": "",
				"status": "",
				"updateBy": "",
				"updateTime": ""
			}
		],
		"sex": "",
		"status": "",
		"updateBy": "",
		"updateTime": "",
		"userId": "",
		"userName": "",
		"userType": ""
	},
	"msg": ""
}

导入用户列表

接口地址:/system/user/importData

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
file	file	formData	false	file
tenant_id	租户ID	header	false	integer(int64)
updateSupport	updateSupport	query	false	boolean

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导入模板

接口地址:/system/user/importTemplate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取当前用户信息

接口地址:/system/user/info/{username}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
username	username	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«LoginUser»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		LoginUser	LoginUser
expireTime		integer(int64)
ipaddr		string
loginTime		integer(int64)
permissions		array	string
roles		array	string
sysUser		SysUser对象	SysUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	SysDept对象	SysDept对象
ancestors	祖级列表	string
children	子部门	array	SysDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	SysRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
updateBy	更新人	string
updateTime	更新时间	string
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
tenantUser		TenantUser对象	TenantUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	TenantDept对象	TenantDept对象
ancestors	祖级列表	string
children	子部门	array	TenantDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	TenantRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
token		string
userid		integer(int64)
username		string
msg		string

响应示例:

{
	"code": 0,
	"data": {
		"expireTime": 0,
		"ipaddr": "",
		"loginTime": 0,
		"permissions": [],
		"roles": [],
		"sysUser": {
			"admin": true,
			"avatar": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"dept": {
				"ancestors": "",
				"children": [
					{
						"ancestors": "",
						"children": [
							{}
						],
						"createBy": "",
						"createTime": "",
						"delFlag": "",
						"deptId": "",
						"deptName": "",
						"deptType": "",
						"email": "",
						"leader": "",
						"orderNum": "",
						"parentId": "",
						"parentName": "",
						"phone": "",
						"status": "",
						"updateBy": "",
						"updateTime": ""
					}
				],
				"createBy": "",
				"createTime": "",
				"delFlag": "",
				"deptId": "",
				"deptName": "",
				"deptType": "",
				"email": "",
				"leader": "",
				"orderNum": "",
				"parentId": "",
				"parentName": "",
				"phone": "",
				"status": "",
				"updateBy": "",
				"updateTime": ""
			},
			"deptId": "",
			"email": "",
			"loginDate": "",
			"loginIp": "",
			"nickName": "",
			"password": "",
			"phonenumber": "",
			"postIds": "",
			"remark": "",
			"roleId": "",
			"roleIds": "",
			"roles": [
				{
					"admin": true,
					"createBy": "",
					"createTime": "",
					"dataScope": "",
					"delFlag": "",
					"deptCheckStrictly": true,
					"deptIds": "",
					"flag": true,
					"menuCheckStrictly": true,
					"menuIds": "",
					"remark": "",
					"roleId": "",
					"roleKey": "",
					"roleName": "",
					"roleSort": "",
					"status": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"sex": "",
			"status": "",
			"updateBy": "",
			"updateTime": "",
			"userId": "",
			"userName": "",
			"userType": ""
		},
		"tenantUser": {
			"admin": true,
			"avatar": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"dept": {
				"ancestors": "",
				"children": [
					{
						"ancestors": "",
						"children": [
							{}
						],
						"createBy": "",
						"createTime": "",
						"delFlag": "",
						"deptId": "",
						"deptName": "",
						"deptType": "",
						"email": "",
						"leader": "",
						"orderNum": "",
						"parentId": "",
						"parentName": "",
						"phone": "",
						"status": "",
						"tenantId": "",
						"updateBy": "",
						"updateTime": ""
					}
				],
				"createBy": "",
				"createTime": "",
				"delFlag": "",
				"deptId": "",
				"deptName": "",
				"deptType": "",
				"email": "",
				"leader": "",
				"orderNum": "",
				"parentId": "",
				"parentName": "",
				"phone": "",
				"status": "",
				"tenantId": "",
				"updateBy": "",
				"updateTime": ""
			},
			"deptId": "",
			"email": "",
			"loginDate": "",
			"loginIp": "",
			"nickName": "",
			"password": "",
			"phonenumber": "",
			"postIds": "",
			"remark": "",
			"roleId": "",
			"roleIds": "",
			"roles": [
				{
					"admin": true,
					"createBy": "",
					"createTime": "",
					"dataScope": "",
					"delFlag": "",
					"deptCheckStrictly": true,
					"deptIds": "",
					"flag": true,
					"menuCheckStrictly": true,
					"menuIds": "",
					"remark": "",
					"roleId": "",
					"roleKey": "",
					"roleName": "",
					"roleSort": "",
					"status": "",
					"tenantId": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"sex": "",
			"status": "",
			"tenantId": "",
			"updateBy": "",
			"updateTime": "",
			"userId": "",
			"userName": "",
			"userType": ""
		},
		"token": "",
		"userid": 0,
		"username": ""
	},
	"msg": ""
}

获取用户列表

接口地址:/system/user/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询部门用户列表

接口地址:/system/user/listByDept/{deptId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

注册用户信息

接口地址:/system/user/register

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
sysUser	用户对象	body	true	SysUser对象	SysUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	SysDept对象	SysDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	SysDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
msg	string

响应示例:

{
	"code": 0,
	"data": true,
	"msg": ""
}

用户重置密码

接口地址:/system/user/resetPwd

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	SysUser对象	SysUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	SysDept对象	SysDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	SysDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除用户

接口地址:/system/user/{userIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userIds	userIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据用户编号获取详细信息

接口地址:/system/user/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userId	userId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-用户-门户

获取token

接口地址:/system/front/user/getToken

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "appCode": "",
  "appToken": "",
  "appUrl": "",
  "password": "",
  "userName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
getTokenDto	获取Token信息Dto	body	true	GetTokenDto对象	GetTokenDto对象
appCode	应用服务编码		false	string
appToken	应用服务签名		false	string
appUrl	应用服务请求地址		false	string
password	密码		false	string
userName	用户账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	GetTokenDto对象
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型
appCode	应用服务编码	string
appToken	应用服务签名	string
appUrl	应用服务请求地址	string
password	密码	string
userName	用户账号	string

响应示例:

{
	"appCode": "",
	"appToken": "",
	"appUrl": "",
	"password": "",
	"userName": ""
}

获取用户列表

接口地址:/system/front/user/syncList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

平台-登录日志

add

接口地址:/system/logininfor

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "accessTime": "",
  "infoId": "",
  "ipaddr": "",
  "msg": "",
  "status": "",
  "userName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
logininfor	系统访问记录表	body	true	SysLogininfor对象	SysLogininfor对象
accessTime	访问时间		false	string(date-time)
infoId	ID		false	string
ipaddr	地址		false	string
msg	描述		false	string
status	状态（0：成功，1：失败）		false	string
userName	用户账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

清除登录日志

接口地址:/system/logininfor/clean

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

导出登录日志列表

接口地址:/system/logininfor/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
accessTime	访问时间	query	false	string(date-time)
infoId	ID	query	false	integer(int64)
ipaddr	地址	query	false	string
msg	描述	query	false	string
params	请求参数	query	false	object
status	状态（0：成功，1：失败）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userName	用户账号	query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询登录日志列表

接口地址:/system/logininfor/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
accessTime	访问时间	query	false	string(date-time)
infoId	ID	query	false	integer(int64)
ipaddr	地址	query	false	string
msg	描述	query	false	string
params	请求参数	query	false	object
status	状态（0：成功，1：失败）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userName	用户账号	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除登录日志

接口地址:/system/logininfor/{infoIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
infoIds	infoIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

平台-租户管理

新增租户

接口地址:/system/tenant

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "email": "",
  "endDate": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "sex": "",
  "startDate": "",
  "status": "",
  "tenantId": "",
  "tenantName": "",
  "tenantNo": "",
  "tenantType": "",
  "userId": "",
  "userName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenantDto	租户管理表Dto	body	true	SysTenantDto对象	SysTenantDto对象
email	用户邮箱		false	string
endDate	租户系统到期时间		false	string(date)
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
sex	用户性别		false	string
startDate	租户系统开始时间		false	string(date)
status	租户状态（0：正常，1：停用）		false	string
tenantId	租户ID		false	string
tenantName	租户名称		false	string
tenantNo	租户编号		false	string
tenantType	租户类型		false	string
userId	用户ID		false	string
userName	用户账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改租户

接口地址:/system/tenant

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "email": "",
  "endDate": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "sex": "",
  "startDate": "",
  "status": "",
  "tenantId": "",
  "tenantName": "",
  "tenantNo": "",
  "tenantType": "",
  "userId": "",
  "userName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenantDto	租户管理表Dto	body	true	SysTenantDto对象	SysTenantDto对象
email	用户邮箱		false	string
endDate	租户系统到期时间		false	string(date)
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
sex	用户性别		false	string
startDate	租户系统开始时间		false	string(date)
status	租户状态（0：正常，1：停用）		false	string
tenantId	租户ID		false	string
tenantName	租户名称		false	string
tenantNo	租户编号		false	string
tenantType	租户类型		false	string
userId	用户ID		false	string
userName	用户账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户状态修改

接口地址:/system/tenant/changeStatus/{tenantIds}/{status}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
status	status	path	true	string
tenantIds	tenantIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出租户列表

接口地址:/system/tenant/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
endDate	租户系统到期时间	query	false	string
startDate	租户系统开始时间	query	false	string
tenantName	租户名称	query	false	string
tenantNo	租户编号	query	false	string
tenantStatus	租户显示状态（1：禁用，2：未开通，3：已开通，4：已过期）	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询租户列表

接口地址:/system/tenant/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
endDate	租户系统到期时间	query	false	string
startDate	租户系统开始时间	query	false	string
tenantName	租户名称	query	false	string
tenantNo	租户编号	query	false	string
tenantStatus	租户显示状态（1：禁用，2：未开通，3：已开通，4：已过期）	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询租户详细

接口地址:/system/tenant/selectById/{tenandId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenandId	tenandId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«SysTenant对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		SysTenant对象	SysTenant对象
createBy	创建人	string
createTime	创建时间	string(date-time)
endDate	租户系统到期时间	string(date-time)
logoUrl	租户LOGO	string
remark	备注	string
startDate	租户系统开始时间	string(date-time)
status	租户状态（0：正常，1：停用）	string
tenantId	租户ID	string
tenantName	租户名称	string
tenantNo	租户编号	string
tenantStatus	租户显示状态（1：禁用，2：未开通，3：已开通，4：已过期）	string
tenantType	租户类型	string
updateBy	更新人	string
updateTime	更新时间	string(date-time)
msg		string

响应示例:

{
	"code": 0,
	"data": {
		"createBy": "",
		"createTime": "",
		"endDate": "",
		"logoUrl": "",
		"remark": "",
		"startDate": "",
		"status": "",
		"tenantId": "",
		"tenantName": "",
		"tenantNo": "",
		"tenantStatus": "",
		"tenantType": "",
		"updateBy": "",
		"updateTime": ""
	},
	"msg": ""
}

查询租户详细

接口地址:/system/tenant/{tenandId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenandId	tenandId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-租户管理-门户

新增租户

接口地址:/system/front/tenant

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "email": "",
  "endDate": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "sex": "",
  "startDate": "",
  "status": "",
  "tenantId": "",
  "tenantName": "",
  "tenantNo": "",
  "tenantType": "",
  "userId": "",
  "userName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenantDto	租户管理表Dto	body	true	SysTenantDto对象	SysTenantDto对象
email	用户邮箱		false	string
endDate	租户系统到期时间		false	string(date)
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
sex	用户性别		false	string
startDate	租户系统开始时间		false	string(date)
status	租户状态（0：正常，1：停用）		false	string
tenantId	租户ID		false	string
tenantName	租户名称		false	string
tenantNo	租户编号		false	string
tenantType	租户类型		false	string
userId	用户ID		false	string
userName	用户账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改租户

接口地址:/system/front/tenant

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "email": "",
  "endDate": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "sex": "",
  "startDate": "",
  "status": "",
  "tenantId": "",
  "tenantName": "",
  "tenantNo": "",
  "tenantType": "",
  "userId": "",
  "userName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenantDto	租户管理表Dto	body	true	SysTenantDto对象	SysTenantDto对象
email	用户邮箱		false	string
endDate	租户系统到期时间		false	string(date)
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
sex	用户性别		false	string
startDate	租户系统开始时间		false	string(date)
status	租户状态（0：正常，1：停用）		false	string
tenantId	租户ID		false	string
tenantName	租户名称		false	string
tenantNo	租户编号		false	string
tenantType	租户类型		false	string
userId	用户ID		false	string
userName	用户账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户状态修改

接口地址:/system/front/tenant/changeStatus/{tenantIds}/{status}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
status	status	path	true	string
tenantIds	tenantIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出租户列表

接口地址:/system/front/tenant/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
endDate	租户系统到期时间	query	false	string
startDate	租户系统开始时间	query	false	string
tenantName	租户名称	query	false	string
tenantNo	租户编号	query	false	string
tenantStatus	租户显示状态（1：禁用，2：未开通，3：已开通，4：已过期）	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询租户列表

接口地址:/system/front/tenant/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
endDate	租户系统到期时间	query	false	string
startDate	租户系统开始时间	query	false	string
tenantName	租户名称	query	false	string
tenantNo	租户编号	query	false	string
tenantStatus	租户显示状态（1：禁用，2：未开通，3：已开通，4：已过期）	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询租户详细

接口地址:/system/front/tenant/{tenandId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenandId	tenandId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-菜单

新增菜单

接口地址:/system/menu

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "children": [
    {
      "children": [],
      "component": "",
      "createBy": "",
      "createTime": "",
      "icon": "",
      "isCache": "",
      "isFrame": "",
      "menuId": "",
      "menuName": "",
      "menuType": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "path": "",
      "perms": "",
      "query": "",
      "remark": "",
      "status": "",
      "updateBy": "",
      "updateTime": "",
      "visible": ""
    }
  ],
  "component": "",
  "createBy": "",
  "createTime": "",
  "icon": "",
  "isCache": "",
  "isFrame": "",
  "menuId": "",
  "menuName": "",
  "menuType": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "path": "",
  "perms": "",
  "query": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "visible": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
menu	菜单权限表	body	true	SysMenu对象	SysMenu对象
children	子菜单		false	array	SysMenu对象
component	组件路径		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
icon	菜单图标		false	string
isCache	是否缓存（0缓存 1不缓存）		false	string
isFrame	是否为外链（0是 1否）		false	string
menuId	菜单ID		false	string
menuName	菜单名称		false	string
menuType	类型（M目录 C菜单 F按钮）		false	string
orderNum	显示顺序		false	string
parentId	父菜单ID		false	string
parentName	父菜单名称		false	string
path	路由地址		false	string
perms	权限字符串		false	string
query	路由参数		false	string
remark	备注		false	string
status	菜单状态（0显示 1隐藏）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
visible	显示状态（0显示 1隐藏）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改菜单

接口地址:/system/menu

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "children": [
    {
      "children": [],
      "component": "",
      "createBy": "",
      "createTime": "",
      "icon": "",
      "isCache": "",
      "isFrame": "",
      "menuId": "",
      "menuName": "",
      "menuType": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "path": "",
      "perms": "",
      "query": "",
      "remark": "",
      "status": "",
      "updateBy": "",
      "updateTime": "",
      "visible": ""
    }
  ],
  "component": "",
  "createBy": "",
  "createTime": "",
  "icon": "",
  "isCache": "",
  "isFrame": "",
  "menuId": "",
  "menuName": "",
  "menuType": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "path": "",
  "perms": "",
  "query": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "visible": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
menu	菜单权限表	body	true	SysMenu对象	SysMenu对象
children	子菜单		false	array	SysMenu对象
component	组件路径		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
icon	菜单图标		false	string
isCache	是否缓存（0缓存 1不缓存）		false	string
isFrame	是否为外链（0是 1否）		false	string
menuId	菜单ID		false	string
menuName	菜单名称		false	string
menuType	类型（M目录 C菜单 F按钮）		false	string
orderNum	显示顺序		false	string
parentId	父菜单ID		false	string
parentName	父菜单名称		false	string
path	路由地址		false	string
perms	权限字符串		false	string
query	路由参数		false	string
remark	备注		false	string
status	菜单状态（0显示 1隐藏）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
visible	显示状态（0显示 1隐藏）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取路由信息

接口地址:/system/menu/getRouters

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取菜单列表

接口地址:/system/menu/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
component	组件路径	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
icon	菜单图标	query	false	string
isCache	是否缓存（0缓存 1不缓存）	query	false	string
isFrame	是否为外链（0是 1否）	query	false	string
menuId	菜单ID	query	false	integer(int64)
menuName	菜单名称	query	false	string
menuType	类型（M目录 C菜单 F按钮）	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父菜单ID	query	false	integer(int64)
parentName	父菜单名称	query	false	string
path	路由地址	query	false	string
perms	权限字符串	query	false	string
query	路由参数	query	false	string
remark	备注	query	false	string
status	菜单状态（0显示 1隐藏）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
visible	显示状态（0显示 1隐藏）	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

加载对应角色菜单列表树

接口地址:/system/menu/roleMenuTreeselect/{roleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleId	roleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取菜单下拉树列表

接口地址:/system/menu/treeselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
component	组件路径	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
icon	菜单图标	query	false	string
isCache	是否缓存（0缓存 1不缓存）	query	false	string
isFrame	是否为外链（0是 1否）	query	false	string
menuId	菜单ID	query	false	integer(int64)
menuName	菜单名称	query	false	string
menuType	类型（M目录 C菜单 F按钮）	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父菜单ID	query	false	integer(int64)
parentName	父菜单名称	query	false	string
path	路由地址	query	false	string
perms	权限字符串	query	false	string
query	路由参数	query	false	string
remark	备注	query	false	string
status	菜单状态（0显示 1隐藏）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
visible	显示状态（0显示 1隐藏）	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据菜单编号获取详细信息

接口地址:/system/menu/{menuId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
menuId	menuId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除菜单

接口地址:/system/menu/{menuId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
menuId	menuId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

平台-角色

新增角色

接口地址:/system/role

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "createBy": "",
  "createTime": "",
  "dataScope": "",
  "delFlag": "",
  "deptCheckStrictly": true,
  "deptIds": "",
  "flag": true,
  "menuCheckStrictly": true,
  "menuIds": "",
  "remark": "",
  "roleId": "",
  "roleKey": "",
  "roleName": "",
  "roleSort": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
role	角色表	body	true	SysRole对象	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改保存角色

接口地址:/system/role

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "createBy": "",
  "createTime": "",
  "dataScope": "",
  "delFlag": "",
  "deptCheckStrictly": true,
  "deptIds": "",
  "flag": true,
  "menuCheckStrictly": true,
  "menuIds": "",
  "remark": "",
  "roleId": "",
  "roleKey": "",
  "roleName": "",
  "roleSort": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
role	角色表	body	true	SysRole对象	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询已分配用户角色列表

接口地址:/system/role/authUser/allocatedList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

取消授权用户

接口地址:/system/role/authUser/cancel

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "roleId": "",
  "userId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
userRole	用户和角色关联	body	true	SysUserRole对象	SysUserRole对象
roleId	角色ID		false	string
userId	用户ID		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量取消授权用户

接口地址:/system/role/authUser/cancelAll

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
roleId	roleId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
userIds	userIds	query	false	array	integer

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量选择用户授权

接口地址:/system/role/authUser/selectAll

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
roleId	roleId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
userIds	userIds	query	false	array	integer

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询未分配用户角色列表

接口地址:/system/role/authUser/unallocatedList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

修改保存数据权限

接口地址:/system/role/dataScope

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "createBy": "",
  "createTime": "",
  "dataScope": "",
  "delFlag": "",
  "deptCheckStrictly": true,
  "deptIds": "",
  "flag": true,
  "menuCheckStrictly": true,
  "menuIds": "",
  "remark": "",
  "roleId": "",
  "roleKey": "",
  "roleName": "",
  "roleSort": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
role	角色表	body	true	SysRole对象	SysRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出角色列表

接口地址:/system/role/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
deptIds	部门组（数据权限）	query	false	array	integer
flag	用户是否存在此角色标识默认不存在	query	false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
menuIds	菜单组	query	false	array	integer
params	请求参数	query	false	object
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleKey	角色权限	query	false	string
roleName	角色名称	query	false	string
roleSort	角色排序	query	false	string
status	角色状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询角色列表

接口地址:/system/role/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
deptIds	部门组（数据权限）	query	false	array	integer
flag	用户是否存在此角色标识默认不存在	query	false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
menuIds	菜单组	query	false	array	integer
params	请求参数	query	false	object
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleKey	角色权限	query	false	string
roleName	角色名称	query	false	string
roleSort	角色排序	query	false	string
status	角色状态（0正常 1停用）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取角色选择框列表

接口地址:/system/role/optionselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除角色

接口地址:/system/role/{roleIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleIds	roleIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据角色编号获取详细信息

接口地址:/system/role/{roleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleId	roleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

平台-部门

新增部门

接口地址:/system/dept

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "ancestors": "",
  "children": [
    {
      "ancestors": "",
      "children": [
        {
          "ancestors": "",
          "children": [
            {}
          ],
          "createBy": "",
          "createTime": "",
          "delFlag": "",
          "deptId": "",
          "deptName": "",
          "deptType": "",
          "email": "",
          "leader": "",
          "orderNum": "",
          "parentId": "",
          "parentName": "",
          "phone": "",
          "status": "",
          "updateBy": "",
          "updateTime": ""
        }
      ],
      "createBy": "",
      "createTime": "",
      "delFlag": "",
      "deptId": "",
      "deptName": "",
      "deptType": "",
      "email": "",
      "leader": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "phone": "",
      "status": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "deptId": "",
  "deptName": "",
  "deptType": "",
  "email": "",
  "leader": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "phone": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dept	部门表	body	true	SysDept对象	SysDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	SysDept对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改部门

接口地址:/system/dept

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "ancestors": "",
  "children": [
    {
      "ancestors": "",
      "children": [
        {
          "ancestors": "",
          "children": [
            {}
          ],
          "createBy": "",
          "createTime": "",
          "delFlag": "",
          "deptId": "",
          "deptName": "",
          "deptType": "",
          "email": "",
          "leader": "",
          "orderNum": "",
          "parentId": "",
          "parentName": "",
          "phone": "",
          "status": "",
          "updateBy": "",
          "updateTime": ""
        }
      ],
      "createBy": "",
      "createTime": "",
      "delFlag": "",
      "deptId": "",
      "deptName": "",
      "deptType": "",
      "email": "",
      "leader": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "phone": "",
      "status": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "deptId": "",
  "deptName": "",
  "deptType": "",
  "email": "",
  "leader": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "phone": "",
  "status": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dept	部门表	body	true	SysDept对象	SysDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	SysDept对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取部门下拉树列表

接口地址:/system/dept/getNormalDeptTree

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取部门列表

接口地址:/system/dept/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
ancestors	祖级列表	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptId	部门ID	query	false	integer(int64)
deptName	部门名称	query	false	string
deptType	部门类型	query	false	string
email	邮箱	query	false	string
leader	负责人	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父部门ID	query	false	integer(int64)
parentName	父部门名称	query	false	string
phone	联系电话	query	false	string
status	部门状态	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询部门列表（排除节点）

接口地址:/system/dept/list/exclude/{deptId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

加载对应角色部门列表树

接口地址:/system/dept/roleDeptTreeselect/{roleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleId	roleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取部门下拉树列表

接口地址:/system/dept/treeselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
ancestors	祖级列表	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptId	部门ID	query	false	integer(int64)
deptName	部门名称	query	false	string
deptType	部门类型	query	false	string
email	邮箱	query	false	string
leader	负责人	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父部门ID	query	false	integer(int64)
parentName	父部门名称	query	false	string
phone	联系电话	query	false	string
status	部门状态	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据部门编号获取详细信息

接口地址:/system/dept/{deptId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除部门

接口地址:/system/dept/{deptId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

微信JS-SDK模块

wx-jssdk-config

接口地址:/system/wxMp/config

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)
url	url	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

注册用户-前台

绑定手机号

接口地址:/system/customerUser/front/bindPhone

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "code": "",
  "phone": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	BindPhoneDto	BindPhoneDto
code			false	string
phone			false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

注销

接口地址:/system/customerUser/front/cancel

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据userName获取用户信息

接口地址:/system/customerUser/front/info/{userName}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenant_id	tenant_id	header	true	string
userName	userName	path	true	string

响应状态:

状态码	说明	schema
200	OK	R«AppLoginUser»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		AppLoginUser	AppLoginUser
customerUser		CustomerUser	CustomerUser
activeStatus	活跃状态，0：不活跃，1：活跃	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志;;0：未删除，1：已删除	string
tenantId	租户ID	string
updateBy	更新者	string
updateTime	更新时间	string
userAddress	用户注册地址	string
userCardNo	用户身份证号码	string
userCardType	用户证件类型（1:居民身份证，2:港澳台通行证）	string
userId	用户Id	string
userImg	用户头像	string
userName	用户名称	string
userNickName	用户昵称	string
userOpenId	用户微信ID	string
userPhone	用户手机号	string
userPwd	用户密码	string
userSex	用户性别(0:未知，1:男，2：女)	string
expireTime		integer(int64)
ipaddr		string
loginTime		integer(int64)
tenantUser		TenantUser对象	TenantUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	TenantDept对象	TenantDept对象
ancestors	祖级列表	string
children	子部门	array	TenantDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	TenantRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
token		string
userid		integer(int64)
username		string
msg		string

响应示例:

{
	"code": 0,
	"data": {
		"customerUser": {
			"activeStatus": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"tenantId": "",
			"updateBy": "",
			"updateTime": "",
			"userAddress": "",
			"userCardNo": "",
			"userCardType": "",
			"userId": "",
			"userImg": "",
			"userName": "",
			"userNickName": "",
			"userOpenId": "",
			"userPhone": "",
			"userPwd": "",
			"userSex": ""
		},
		"expireTime": 0,
		"ipaddr": "",
		"loginTime": 0,
		"tenantUser": {
			"admin": true,
			"avatar": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"dept": {
				"ancestors": "",
				"children": [
					{
						"ancestors": "",
						"children": [
							{}
						],
						"createBy": "",
						"createTime": "",
						"delFlag": "",
						"deptId": "",
						"deptName": "",
						"deptType": "",
						"email": "",
						"leader": "",
						"orderNum": "",
						"parentId": "",
						"parentName": "",
						"phone": "",
						"status": "",
						"tenantId": "",
						"updateBy": "",
						"updateTime": ""
					}
				],
				"createBy": "",
				"createTime": "",
				"delFlag": "",
				"deptId": "",
				"deptName": "",
				"deptType": "",
				"email": "",
				"leader": "",
				"orderNum": "",
				"parentId": "",
				"parentName": "",
				"phone": "",
				"status": "",
				"tenantId": "",
				"updateBy": "",
				"updateTime": ""
			},
			"deptId": "",
			"email": "",
			"loginDate": "",
			"loginIp": "",
			"nickName": "",
			"password": "",
			"phonenumber": "",
			"postIds": "",
			"remark": "",
			"roleId": "",
			"roleIds": "",
			"roles": [
				{
					"admin": true,
					"createBy": "",
					"createTime": "",
					"dataScope": "",
					"delFlag": "",
					"deptCheckStrictly": true,
					"deptIds": "",
					"flag": true,
					"menuCheckStrictly": true,
					"menuIds": "",
					"remark": "",
					"roleId": "",
					"roleKey": "",
					"roleName": "",
					"roleSort": "",
					"status": "",
					"tenantId": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"sex": "",
			"status": "",
			"tenantId": "",
			"updateBy": "",
			"updateTime": "",
			"userId": "",
			"userName": "",
			"userType": ""
		},
		"token": "",
		"userid": 0,
		"username": ""
	},
	"msg": ""
}

获取验证码

接口地址:/system/customerUser/front/noLogin/getCode/{phone}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
phone	phone	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据userPhone获取用户信息

接口地址:/system/customerUser/front/phoneLogin/{userPhone}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenant_id	tenant_id	header	true	string
userPhone	userPhone	path	true	string

响应状态:

状态码	说明	schema
200	OK	R«AppLoginUser»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		AppLoginUser	AppLoginUser
customerUser		CustomerUser	CustomerUser
activeStatus	活跃状态，0：不活跃，1：活跃	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志;;0：未删除，1：已删除	string
tenantId	租户ID	string
updateBy	更新者	string
updateTime	更新时间	string
userAddress	用户注册地址	string
userCardNo	用户身份证号码	string
userCardType	用户证件类型（1:居民身份证，2:港澳台通行证）	string
userId	用户Id	string
userImg	用户头像	string
userName	用户名称	string
userNickName	用户昵称	string
userOpenId	用户微信ID	string
userPhone	用户手机号	string
userPwd	用户密码	string
userSex	用户性别(0:未知，1:男，2：女)	string
expireTime		integer(int64)
ipaddr		string
loginTime		integer(int64)
tenantUser		TenantUser对象	TenantUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	TenantDept对象	TenantDept对象
ancestors	祖级列表	string
children	子部门	array	TenantDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	TenantRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
token		string
userid		integer(int64)
username		string
msg		string

响应示例:

{
	"code": 0,
	"data": {
		"customerUser": {
			"activeStatus": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"tenantId": "",
			"updateBy": "",
			"updateTime": "",
			"userAddress": "",
			"userCardNo": "",
			"userCardType": "",
			"userId": "",
			"userImg": "",
			"userName": "",
			"userNickName": "",
			"userOpenId": "",
			"userPhone": "",
			"userPwd": "",
			"userSex": ""
		},
		"expireTime": 0,
		"ipaddr": "",
		"loginTime": 0,
		"tenantUser": {
			"admin": true,
			"avatar": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"dept": {
				"ancestors": "",
				"children": [
					{
						"ancestors": "",
						"children": [
							{}
						],
						"createBy": "",
						"createTime": "",
						"delFlag": "",
						"deptId": "",
						"deptName": "",
						"deptType": "",
						"email": "",
						"leader": "",
						"orderNum": "",
						"parentId": "",
						"parentName": "",
						"phone": "",
						"status": "",
						"tenantId": "",
						"updateBy": "",
						"updateTime": ""
					}
				],
				"createBy": "",
				"createTime": "",
				"delFlag": "",
				"deptId": "",
				"deptName": "",
				"deptType": "",
				"email": "",
				"leader": "",
				"orderNum": "",
				"parentId": "",
				"parentName": "",
				"phone": "",
				"status": "",
				"tenantId": "",
				"updateBy": "",
				"updateTime": ""
			},
			"deptId": "",
			"email": "",
			"loginDate": "",
			"loginIp": "",
			"nickName": "",
			"password": "",
			"phonenumber": "",
			"postIds": "",
			"remark": "",
			"roleId": "",
			"roleIds": "",
			"roles": [
				{
					"admin": true,
					"createBy": "",
					"createTime": "",
					"dataScope": "",
					"delFlag": "",
					"deptCheckStrictly": true,
					"deptIds": "",
					"flag": true,
					"menuCheckStrictly": true,
					"menuIds": "",
					"remark": "",
					"roleId": "",
					"roleKey": "",
					"roleName": "",
					"roleSort": "",
					"status": "",
					"tenantId": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"sex": "",
			"status": "",
			"tenantId": "",
			"updateBy": "",
			"updateTime": "",
			"userId": "",
			"userName": "",
			"userType": ""
		},
		"token": "",
		"userid": 0,
		"username": ""
	},
	"msg": ""
}

用户注册

接口地址:/system/customerUser/front/register

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "registerWay": "",
  "userImg": "",
  "userName": "",
  "userPhone": "",
  "userPwd": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	InsertCustomerDto	InsertCustomerDto
registerWay	注册方式{1：用户名 2：手机号}		false	string
userImg	用户头像		false	string
userName	用户名称，暂用手机号		false	string
userPhone	用户手机号		false	string
userPwd	用户密码		false	string
tenant_id	tenant_id	header	true	string

响应状态:

状态码	说明	schema
200	OK	R«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
msg	string

响应示例:

{
	"code": 0,
	"data": true,
	"msg": ""
}

更新用户

接口地址:/system/customerUser/front/updateAppUserById

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

[
  {
    "activeStatus": "",
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "tenantId": "",
    "updateBy": "",
    "updateTime": "",
    "userAddress": "",
    "userCardNo": "",
    "userCardType": "",
    "userId": "",
    "userImg": "",
    "userName": "",
    "userNickName": "",
    "userOpenId": "",
    "userPhone": "",
    "userPwd": "",
    "userSex": ""
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
customerUsers	customerUsers	body	true	array	CustomerUser
activeStatus	活跃状态，0：不活跃，1：活跃		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志;;0：未删除，1：已删除		false	string
tenantId	租户ID		false	string
updateBy	更新者		false	string
updateTime	更新时间		false	string(date-time)
userAddress	用户注册地址		false	string
userCardNo	用户身份证号码		false	string
userCardType	用户证件类型（1:居民身份证，2:港澳台通行证）		false	string
userId	用户Id		false	string
userImg	用户头像		false	string
userName	用户名称		false	string
userNickName	用户昵称		false	string
userOpenId	用户微信ID		false	string
userPhone	用户手机号		false	string
userPwd	用户密码		false	string
userSex	用户性别(0:未知，1:男，2：女)		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户信息修改

接口地址:/system/customerUser/front/updateInfo

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "userId": 0,
  "userImg": "",
  "userNickName": "",
  "userSex": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	UpdateCustomerDto	UpdateCustomerDto
userId	用户Id		false	integer(int64)
userImg	用户头像		false	string
userNickName	用户昵称		false	string
userSex	用户性别		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改密码

接口地址:/system/customerUser/front/updatePwd

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "newPwd": "",
  "oldPwd": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dto	dto	body	true	UpdatePwdDto	UpdatePwdDto
newPwd	新密码		false	string
oldPwd	原密码		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取用户信息详情

接口地址:/system/customerUser/front/userInfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
appUserId	appUserId	path	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取用户信息详情

接口地址:/system/customerUser/front/userInfo/{appUserId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
appUserId	appUserId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

注册用户-运营后台

注销

接口地址:/system/tenant/customerUser/cancel

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)
userIds	userIds	query	false	array	integer

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

查询注册用户列表

接口地址:/system/tenant/customerUser/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createTimeDateEnd	注册时间止	query	false	string(date)
createTimeStart	注册时间起	query	false	string(date)
delFlag	用户状态用户状态{0:正常 1：注销}	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userName	用户名称	query	false	string
userPhone	用户手机号	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取用户信息详情

接口地址:/system/tenant/customerUser/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userId	userId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户-个人信息

获取个人信息

接口地址:/system/tenant/user/profile

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改个人信息

接口地址:/system/tenant/user/profile

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "tenantId": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "tenantId": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "tenantId": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	TenantUser对象	TenantUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	TenantDept对象	TenantDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	TenantDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户头像上传

接口地址:/system/tenant/user/profile/avatar

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
avatarfile	avatarfile	formData	true	file
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

个人信息重置密码

接口地址:/system/tenant/user/profile/updatePwd

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
newPassword	newPassword	query	false	string
oldPassword	oldPassword	query	false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户-公告

新增通知公告

接口地址:/system/tenant/notice

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "fileName": "",
  "fileUrl": "",
  "noticeContent": "",
  "noticeId": "",
  "noticeTitle": "",
  "noticeType": "",
  "releaseMechanism": "",
  "remark": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
notice	通知公告表	body	true	TenantNotice对象	TenantNotice对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）		false	string
fileName	附件名称		false	string
fileUrl	附件地址		false	string
noticeContent	公告内容		false	string
noticeId	公告ID		false	string
noticeTitle	公告标题		false	string
noticeType	公告类型（1：通知，2：公告）		false	string
releaseMechanism	发布机构		false	string
remark	备注		false	string
status	公告状态（0：正常，1：关闭）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改通知公告

接口地址:/system/tenant/notice

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "fileName": "",
  "fileUrl": "",
  "noticeContent": "",
  "noticeId": "",
  "noticeTitle": "",
  "noticeType": "",
  "releaseMechanism": "",
  "remark": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
notice	通知公告表	body	true	TenantNotice对象	TenantNotice对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）		false	string
fileName	附件名称		false	string
fileUrl	附件地址		false	string
noticeContent	公告内容		false	string
noticeId	公告ID		false	string
noticeTitle	公告标题		false	string
noticeType	公告类型（1：通知，2：公告）		false	string
releaseMechanism	发布机构		false	string
remark	备注		false	string
status	公告状态（0：正常，1：关闭）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除通知公告

接口地址:/system/tenant/notice/delete/{noticeId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

管理端-获取通知公告列表

接口地址:/system/tenant/notice/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）	query	false	string
fileName	附件名称	query	false	string
fileUrl	附件地址	query	false	string
noticeContent	公告内容	query	false	string
noticeId	公告ID	query	false	integer(int64)
noticeTitle	公告标题	query	false	string
noticeType	公告类型（1：通知，2：公告）	query	false	string
releaseMechanism	发布机构	query	false	string
remark	备注	query	false	string
status	公告状态（0：正常，1：关闭）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

下线通知公告

接口地址:/system/tenant/notice/offlineNotice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

上线通知公告

接口地址:/system/tenant/notice/onlineNotice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

管理端-根据通知公告编号获取详细信息

接口地址:/system/tenant/notice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户-公告-门户

门户-获取通知公告列表

接口地址:/system/front/tenant/notice/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0：未删除，1：已删除）	query	false	string
fileName	附件名称	query	false	string
fileUrl	附件地址	query	false	string
noticeContent	公告内容	query	false	string
noticeId	公告ID	query	false	integer(int64)
noticeTitle	公告标题	query	false	string
noticeType	公告类型（1：通知，2：公告）	query	false	string
releaseMechanism	发布机构	query	false	string
remark	备注	query	false	string
status	公告状态（0：正常，1：关闭）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

门户-根据通知公告编号获取详细信息

接口地址:/system/front/tenant/notice/{noticeId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
noticeId	noticeId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户-在线用户监控

查询在线用户列表

接口地址:/system/tenant/online/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
ipaddr	ipaddr	query	false	string
tenant_id	租户ID	header	false	integer(int64)
userName	userName	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

强退用户

接口地址:/system/tenant/online/{tokenId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tokenId	tokenId	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

租户-岗位

新增岗位

接口地址:/system/tenant/post

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "flag": true,
  "postCode": "",
  "postId": "",
  "postName": "",
  "postSort": "",
  "remark": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
post	岗位表	body	true	TenantPost对象	TenantPost对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
flag	用户是否存在此岗位标识默认不存在		false	boolean
postCode	岗位编码		false	string
postId	岗位序号		false	string
postName	岗位名称		false	string
postSort	岗位排序		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改岗位

接口地址:/system/tenant/post

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createBy": "",
  "createTime": "",
  "flag": true,
  "postCode": "",
  "postId": "",
  "postName": "",
  "postSort": "",
  "remark": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
post	岗位表	body	true	TenantPost对象	TenantPost对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
flag	用户是否存在此岗位标识默认不存在		false	boolean
postCode	岗位编码		false	string
postId	岗位序号		false	string
postName	岗位名称		false	string
postSort	岗位排序		false	string
remark	备注		false	string
status	状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出岗位列表

接口地址:/system/tenant/post/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
flag	用户是否存在此岗位标识默认不存在	query	false	boolean
postCode	岗位编码	query	false	string
postId	岗位序号	query	false	integer(int64)
postName	岗位名称	query	false	string
postSort	岗位排序	query	false	string
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取岗位列表

接口地址:/system/tenant/post/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
flag	用户是否存在此岗位标识默认不存在	query	false	boolean
postCode	岗位编码	query	false	string
postId	岗位序号	query	false	integer(int64)
postName	岗位名称	query	false	string
postSort	岗位排序	query	false	string
remark	备注	query	false	string
status	状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取岗位选择框列表

接口地址:/system/tenant/post/optionselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除岗位

接口地址:/system/tenant/post/{postIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
postIds	postIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据岗位编号获取详细信息

接口地址:/system/tenant/post/{postId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
postId	postId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户-日志

add

接口地址:/system/tenant/operlog

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "businessType": "",
  "businessTypes": [],
  "deptName": "",
  "errorMsg": "",
  "jsonResult": "",
  "method": "",
  "operId": "",
  "operIp": "",
  "operLocation": "",
  "operName": "",
  "operParam": "",
  "operTime": "",
  "operUrl": "",
  "operatorType": "",
  "requestMethod": "",
  "status": "",
  "tenantId": "",
  "title": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
operLog	操作日志记录表	body	true	TenantOperLog对象	TenantOperLog对象
businessType	业务类型（0：其它，1：新增， 2：修改，3：删除，4：授权，5：导出，6：导入，7：强退，8：生成代码，9：清空数据）		false	string
businessTypes	业务类型数组		false	array	string
deptName	部门名称		false	string
errorMsg	错误消息		false	string
jsonResult	返回参数		false	string
method	请求方法		false	string
operId	日志主键		false	string
operIp	操作地址		false	string
operLocation	操作地点		false	string
operName	操作人员		false	string
operParam	请求参数		false	string
operTime	操作时间		false	string(date-time)
operUrl	请求URL		false	string
operatorType	操作类别（0：其它，1：后台用户，2：手机端用户）		false	string
requestMethod	请求方式		false	string
status	操作状态（0：正常，1：异常）		false	string
tenantId	租户ID		false	string
title	操作模块		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

清除日志

接口地址:/system/tenant/operlog/clean

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

导出日志

接口地址:/system/tenant/operlog/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
businessType	业务类型（0：其它，1：新增， 2：修改，3：删除，4：授权，5：导出，6：导入，7：强退，8：生成代码，9：清空数据）	query	false	string
businessTypes	业务类型数组	query	false	array	string
deptName	部门名称	query	false	string
errorMsg	错误消息	query	false	string
jsonResult	返回参数	query	false	string
method	请求方法	query	false	string
operId	日志主键	query	false	integer(int64)
operIp	操作地址	query	false	string
operLocation	操作地点	query	false	string
operName	操作人员	query	false	string
operParam	请求参数	query	false	string
operTime	操作时间	query	false	string(date-time)
operUrl	请求URL	query	false	string
operatorType	操作类别（0：其它，1：后台用户，2：手机端用户）	query	false	string
params	请求参数	query	false	object
requestMethod	请求方式	query	false	string
status	操作状态（0：正常，1：异常）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
title	操作模块	query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

日志列表

接口地址:/system/tenant/operlog/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
businessType	业务类型（0：其它，1：新增， 2：修改，3：删除，4：授权，5：导出，6：导入，7：强退，8：生成代码，9：清空数据）	query	false	string
businessTypes	业务类型数组	query	false	array	string
deptName	部门名称	query	false	string
errorMsg	错误消息	query	false	string
jsonResult	返回参数	query	false	string
method	请求方法	query	false	string
operId	日志主键	query	false	integer(int64)
operIp	操作地址	query	false	string
operLocation	操作地点	query	false	string
operName	操作人员	query	false	string
operParam	请求参数	query	false	string
operTime	操作时间	query	false	string(date-time)
operUrl	请求URL	query	false	string
operatorType	操作类别（0：其它，1：后台用户，2：手机端用户）	query	false	string
params	请求参数	query	false	object
requestMethod	请求方式	query	false	string
status	操作状态（0：正常，1：异常）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
title	操作模块	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除日志

接口地址:/system/tenant/operlog/{operIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
operIds	operIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

租户-用户

新增用户

接口地址:/system/tenant/user

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "tenantId": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "tenantId": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "tenantId": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	TenantUser对象	TenantUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	TenantDept对象	TenantDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	TenantDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改用户

接口地址:/system/tenant/user

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "tenantId": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "tenantId": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "tenantId": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	TenantUser对象	TenantUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	TenantDept对象	TenantDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	TenantDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据用户编号获取详细信息

接口地址:/system/tenant/user/

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)
userId	userId	path	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户授权角色

接口地址:/system/tenant/user/authRole

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
roleIds	roleIds	query	false	array	integer
tenant_id	租户ID	header	false	integer(int64)
userId	userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据用户编号获取授权角色

接口地址:/system/tenant/user/authRole/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userId	userId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

用户状态修改

接口地址:/system/tenant/user/changeStatus/{id}/{status}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
id	id	path	true	integer(int64)
status	status	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出用户列表

接口地址:/system/tenant/user/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.tenantId	租户ID	query	false	integer(int64)
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].tenantId	租户ID	query	false	integer(int64)
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取用户信息

接口地址:/system/tenant/user/getInfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据租户账号获取租户昵称

接口地址:/system/tenant/user/getNickNameByUsername/{username}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
username	username	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«string»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	string
msg	string

响应示例:

{
	"code": 0,
	"data": "",
	"msg": ""
}

获取当前用户信息

接口地址:/system/tenant/user/getTenantUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«TenantUser对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		TenantUser对象	TenantUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	TenantDept对象	TenantDept对象
ancestors	祖级列表	string
children	子部门	array	TenantDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string(date-time)
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	TenantRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string(date-time)
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
msg		string

响应示例:

{
	"code": 0,
	"data": {
		"admin": true,
		"avatar": "",
		"createBy": "",
		"createTime": "",
		"delFlag": "",
		"dept": {
			"ancestors": "",
			"children": [
				{
					"ancestors": "",
					"children": [
						{}
					],
					"createBy": "",
					"createTime": "",
					"delFlag": "",
					"deptId": "",
					"deptName": "",
					"deptType": "",
					"email": "",
					"leader": "",
					"orderNum": "",
					"parentId": "",
					"parentName": "",
					"phone": "",
					"status": "",
					"tenantId": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"deptId": "",
			"deptName": "",
			"deptType": "",
			"email": "",
			"leader": "",
			"orderNum": "",
			"parentId": "",
			"parentName": "",
			"phone": "",
			"status": "",
			"tenantId": "",
			"updateBy": "",
			"updateTime": ""
		},
		"deptId": "",
		"email": "",
		"loginDate": "",
		"loginIp": "",
		"nickName": "",
		"password": "",
		"phonenumber": "",
		"postIds": "",
		"remark": "",
		"roleId": "",
		"roleIds": "",
		"roles": [
			{
				"admin": true,
				"createBy": "",
				"createTime": "",
				"dataScope": "",
				"delFlag": "",
				"deptCheckStrictly": true,
				"deptIds": "",
				"flag": true,
				"menuCheckStrictly": true,
				"menuIds": "",
				"remark": "",
				"roleId": "",
				"roleKey": "",
				"roleName": "",
				"roleSort": "",
				"status": "",
				"tenantId": "",
				"updateBy": "",
				"updateTime": ""
			}
		],
		"sex": "",
		"status": "",
		"tenantId": "",
		"updateBy": "",
		"updateTime": "",
		"userId": "",
		"userName": "",
		"userType": ""
	},
	"msg": ""
}

导入用户列表

接口地址:/system/tenant/user/importData

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
file	file	formData	false	file
tenant_id	租户ID	header	false	integer(int64)
updateSupport	updateSupport	query	false	boolean

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导入模板

接口地址:/system/tenant/user/importTemplate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取当前用户信息

接口地址:/system/tenant/user/info/{username}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
username	username	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«LoginUser»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		LoginUser	LoginUser
expireTime		integer(int64)
ipaddr		string
loginTime		integer(int64)
permissions		array	string
roles		array	string
sysUser		SysUser对象	SysUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	SysDept对象	SysDept对象
ancestors	祖级列表	string
children	子部门	array	SysDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	SysRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
updateBy	更新人	string
updateTime	更新时间	string
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
tenantUser		TenantUser对象	TenantUser对象
admin		boolean
avatar	用户头像	string
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
dept	部门对象	TenantDept对象	TenantDept对象
ancestors	祖级列表	string
children	子部门	array	TenantDept对象
createBy	创建人	string
createTime	创建时间	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptId	部门ID	string
deptName	部门名称	string
deptType	部门类型	string
email	邮箱	string
leader	负责人	string
orderNum	显示顺序	string
parentId	父部门ID	string
parentName	父部门名称	string
phone	联系电话	string
status	部门状态	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
deptId	部门ID	string
email	用户邮箱	string
loginDate	最后登录时间	string
loginIp	最后登录IP	string
nickName	用户昵称	string
password	密码	string
phonenumber	手机号码	string
postIds	岗位组	string
remark	备注	string
roleId	角色ID	string
roleIds	角色组	string
roles	角色对象	array	TenantRole对象
admin		boolean
createBy	创建人	string
createTime	创建时间	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	string
delFlag	删除标志（0代表存在 2代表删除）	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	boolean
deptIds	部门组（数据权限）	string
flag	用户是否存在此角色标识默认不存在	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	boolean
menuIds	菜单组	string
remark	备注	string
roleId	角色ID	string
roleKey	角色权限	string
roleName	角色名称	string
roleSort	角色排序	string
status	角色状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
sex	用户性别	string
status	帐号状态（0正常 1停用）	string
tenantId	租户ID	string
updateBy	更新人	string
updateTime	更新时间	string
userId	用户ID	string
userName	用户账号	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	string
token		string
userid		integer(int64)
username		string
msg		string

响应示例:

{
	"code": 0,
	"data": {
		"expireTime": 0,
		"ipaddr": "",
		"loginTime": 0,
		"permissions": [],
		"roles": [],
		"sysUser": {
			"admin": true,
			"avatar": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"dept": {
				"ancestors": "",
				"children": [
					{
						"ancestors": "",
						"children": [
							{}
						],
						"createBy": "",
						"createTime": "",
						"delFlag": "",
						"deptId": "",
						"deptName": "",
						"deptType": "",
						"email": "",
						"leader": "",
						"orderNum": "",
						"parentId": "",
						"parentName": "",
						"phone": "",
						"status": "",
						"updateBy": "",
						"updateTime": ""
					}
				],
				"createBy": "",
				"createTime": "",
				"delFlag": "",
				"deptId": "",
				"deptName": "",
				"deptType": "",
				"email": "",
				"leader": "",
				"orderNum": "",
				"parentId": "",
				"parentName": "",
				"phone": "",
				"status": "",
				"updateBy": "",
				"updateTime": ""
			},
			"deptId": "",
			"email": "",
			"loginDate": "",
			"loginIp": "",
			"nickName": "",
			"password": "",
			"phonenumber": "",
			"postIds": "",
			"remark": "",
			"roleId": "",
			"roleIds": "",
			"roles": [
				{
					"admin": true,
					"createBy": "",
					"createTime": "",
					"dataScope": "",
					"delFlag": "",
					"deptCheckStrictly": true,
					"deptIds": "",
					"flag": true,
					"menuCheckStrictly": true,
					"menuIds": "",
					"remark": "",
					"roleId": "",
					"roleKey": "",
					"roleName": "",
					"roleSort": "",
					"status": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"sex": "",
			"status": "",
			"updateBy": "",
			"updateTime": "",
			"userId": "",
			"userName": "",
			"userType": ""
		},
		"tenantUser": {
			"admin": true,
			"avatar": "",
			"createBy": "",
			"createTime": "",
			"delFlag": "",
			"dept": {
				"ancestors": "",
				"children": [
					{
						"ancestors": "",
						"children": [
							{}
						],
						"createBy": "",
						"createTime": "",
						"delFlag": "",
						"deptId": "",
						"deptName": "",
						"deptType": "",
						"email": "",
						"leader": "",
						"orderNum": "",
						"parentId": "",
						"parentName": "",
						"phone": "",
						"status": "",
						"tenantId": "",
						"updateBy": "",
						"updateTime": ""
					}
				],
				"createBy": "",
				"createTime": "",
				"delFlag": "",
				"deptId": "",
				"deptName": "",
				"deptType": "",
				"email": "",
				"leader": "",
				"orderNum": "",
				"parentId": "",
				"parentName": "",
				"phone": "",
				"status": "",
				"tenantId": "",
				"updateBy": "",
				"updateTime": ""
			},
			"deptId": "",
			"email": "",
			"loginDate": "",
			"loginIp": "",
			"nickName": "",
			"password": "",
			"phonenumber": "",
			"postIds": "",
			"remark": "",
			"roleId": "",
			"roleIds": "",
			"roles": [
				{
					"admin": true,
					"createBy": "",
					"createTime": "",
					"dataScope": "",
					"delFlag": "",
					"deptCheckStrictly": true,
					"deptIds": "",
					"flag": true,
					"menuCheckStrictly": true,
					"menuIds": "",
					"remark": "",
					"roleId": "",
					"roleKey": "",
					"roleName": "",
					"roleSort": "",
					"status": "",
					"tenantId": "",
					"updateBy": "",
					"updateTime": ""
				}
			],
			"sex": "",
			"status": "",
			"tenantId": "",
			"updateBy": "",
			"updateTime": "",
			"userId": "",
			"userName": "",
			"userType": ""
		},
		"token": "",
		"userid": 0,
		"username": ""
	},
	"msg": ""
}

获取用户列表

接口地址:/system/tenant/user/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.tenantId	租户ID	query	false	integer(int64)
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].tenantId	租户ID	query	false	integer(int64)
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

查询部门用户列表

接口地址:/system/tenant/user/listByDept/{deptId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

注册用户信息

接口地址:/system/tenant/user/register

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "tenantId": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "tenantId": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "tenantId": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
TenantUser	用户对象	body	true	TenantUser对象	TenantUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	TenantDept对象	TenantDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	TenantDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	R«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
msg	string

响应示例:

{
	"code": 0,
	"data": true,
	"msg": ""
}

用户重置密码

接口地址:/system/tenant/user/resetPwd

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "avatar": "",
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "dept": {
    "ancestors": "",
    "children": [
      {
        "ancestors": "",
        "children": [
          {}
        ],
        "createBy": "",
        "createTime": "",
        "delFlag": "",
        "deptId": "",
        "deptName": "",
        "deptType": "",
        "email": "",
        "leader": "",
        "orderNum": "",
        "parentId": "",
        "parentName": "",
        "phone": "",
        "status": "",
        "tenantId": "",
        "updateBy": "",
        "updateTime": ""
      }
    ],
    "createBy": "",
    "createTime": "",
    "delFlag": "",
    "deptId": "",
    "deptName": "",
    "deptType": "",
    "email": "",
    "leader": "",
    "orderNum": "",
    "parentId": "",
    "parentName": "",
    "phone": "",
    "status": "",
    "tenantId": "",
    "updateBy": "",
    "updateTime": ""
  },
  "deptId": "",
  "email": "",
  "loginDate": "",
  "loginIp": "",
  "nickName": "",
  "password": "",
  "phonenumber": "",
  "postIds": "",
  "remark": "",
  "roleId": "",
  "roleIds": "",
  "roles": [
    {
      "admin": true,
      "createBy": "",
      "createTime": "",
      "dataScope": "",
      "delFlag": "",
      "deptCheckStrictly": true,
      "deptIds": "",
      "flag": true,
      "menuCheckStrictly": true,
      "menuIds": "",
      "remark": "",
      "roleId": "",
      "roleKey": "",
      "roleName": "",
      "roleSort": "",
      "status": "",
      "tenantId": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "sex": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": "",
  "userId": "",
  "userName": "",
  "userType": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
user	用户对象	body	true	TenantUser对象	TenantUser对象
admin			false	boolean
avatar	用户头像		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
dept	部门对象		false	TenantDept对象	TenantDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	TenantDept对象
createBy	创建人		false	string
createTime	创建时间		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
deptId	部门ID		false	string
email	用户邮箱		false	string
loginDate	最后登录时间		false	string(date-time)
loginIp	最后登录IP		false	string
nickName	用户昵称		false	string
password	密码		false	string
phonenumber	手机号码		false	string
postIds	岗位组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleIds	角色组		false	string
roles	角色对象		false	array	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string
sex	用户性别		false	string
status	帐号状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
userId	用户ID		false	string
userName	用户账号		false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除用户

接口地址:/system/tenant/user/{userIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userIds	userIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据用户编号获取详细信息

接口地址:/system/tenant/user/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
userId	userId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户-登录日志

add

接口地址:/system/tenant/logininfor

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "accessTime": "",
  "infoId": "",
  "ipaddr": "",
  "msg": "",
  "status": "",
  "tenantId": "",
  "userName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
logininfor	系统访问记录表	body	true	TenantLogininfor对象	TenantLogininfor对象
accessTime	访问时间		false	string(date-time)
infoId	ID		false	string
ipaddr	地址		false	string
msg	描述		false	string
status	状态（0：成功，1：失败）		false	string
tenantId	租户ID		false	string
userName	用户账号		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

清除登录日志

接口地址:/system/tenant/logininfor/clean

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

导出登录日志列表

接口地址:/system/tenant/logininfor/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
accessTime	访问时间	query	false	string(date-time)
infoId	ID	query	false	integer(int64)
ipaddr	地址	query	false	string
msg	描述	query	false	string
params	请求参数	query	false	object
status	状态（0：成功，1：失败）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
userName	用户账号	query	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询登录日志列表

接口地址:/system/tenant/logininfor/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
accessTime	访问时间	query	false	string(date-time)
infoId	ID	query	false	integer(int64)
ipaddr	地址	query	false	string
msg	描述	query	false	string
params	请求参数	query	false	object
status	状态（0：成功，1：失败）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
userName	用户账号	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

删除登录日志

接口地址:/system/tenant/logininfor/{infoIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
infoIds	infoIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

租户-菜单

新增菜单

接口地址:/system/tenant/menu

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "children": [
    {
      "children": [],
      "component": "",
      "createBy": "",
      "createTime": "",
      "icon": "",
      "isCache": "",
      "isFrame": "",
      "menuId": "",
      "menuName": "",
      "menuType": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "path": "",
      "perms": "",
      "query": "",
      "remark": "",
      "status": "",
      "updateBy": "",
      "updateTime": "",
      "visible": ""
    }
  ],
  "component": "",
  "createBy": "",
  "createTime": "",
  "icon": "",
  "isCache": "",
  "isFrame": "",
  "menuId": "",
  "menuName": "",
  "menuType": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "path": "",
  "perms": "",
  "query": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "visible": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
menu	菜单权限表	body	true	TenantMenu对象	TenantMenu对象
children	子菜单		false	array	TenantMenu对象
component	组件路径		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
icon	菜单图标		false	string
isCache	是否缓存（0缓存 1不缓存）		false	string
isFrame	是否为外链（0是 1否）		false	string
menuId	菜单ID		false	string
menuName	菜单名称		false	string
menuType	类型（M目录 C菜单 F按钮）		false	string
orderNum	显示顺序		false	string
parentId	父菜单ID		false	string
parentName	父菜单名称		false	string
path	路由地址		false	string
perms	权限字符串		false	string
query	路由参数		false	string
remark	备注		false	string
status	菜单状态（0显示 1隐藏）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
visible	显示状态（0显示 1隐藏）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改菜单

接口地址:/system/tenant/menu

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "children": [
    {
      "children": [],
      "component": "",
      "createBy": "",
      "createTime": "",
      "icon": "",
      "isCache": "",
      "isFrame": "",
      "menuId": "",
      "menuName": "",
      "menuType": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "path": "",
      "perms": "",
      "query": "",
      "remark": "",
      "status": "",
      "updateBy": "",
      "updateTime": "",
      "visible": ""
    }
  ],
  "component": "",
  "createBy": "",
  "createTime": "",
  "icon": "",
  "isCache": "",
  "isFrame": "",
  "menuId": "",
  "menuName": "",
  "menuType": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "path": "",
  "perms": "",
  "query": "",
  "remark": "",
  "status": "",
  "updateBy": "",
  "updateTime": "",
  "visible": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
menu	菜单权限表	body	true	TenantMenu对象	TenantMenu对象
children	子菜单		false	array	TenantMenu对象
component	组件路径		false	string
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
icon	菜单图标		false	string
isCache	是否缓存（0缓存 1不缓存）		false	string
isFrame	是否为外链（0是 1否）		false	string
menuId	菜单ID		false	string
menuName	菜单名称		false	string
menuType	类型（M目录 C菜单 F按钮）		false	string
orderNum	显示顺序		false	string
parentId	父菜单ID		false	string
parentName	父菜单名称		false	string
path	路由地址		false	string
perms	权限字符串		false	string
query	路由参数		false	string
remark	备注		false	string
status	菜单状态（0显示 1隐藏）		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
visible	显示状态（0显示 1隐藏）		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取路由信息

接口地址:/system/tenant/menu/getRouters

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取菜单列表

接口地址:/system/tenant/menu/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
component	组件路径	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
icon	菜单图标	query	false	string
isCache	是否缓存（0缓存 1不缓存）	query	false	string
isFrame	是否为外链（0是 1否）	query	false	string
menuId	菜单ID	query	false	integer(int64)
menuName	菜单名称	query	false	string
menuType	类型（M目录 C菜单 F按钮）	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父菜单ID	query	false	integer(int64)
parentName	父菜单名称	query	false	string
path	路由地址	query	false	string
perms	权限字符串	query	false	string
query	路由参数	query	false	string
remark	备注	query	false	string
status	菜单状态（0显示 1隐藏）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
visible	显示状态（0显示 1隐藏）	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

加载对应角色菜单列表树

接口地址:/system/tenant/menu/roleMenuTreeselect/{roleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleId	roleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取菜单下拉树列表

接口地址:/system/tenant/menu/treeselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
component	组件路径	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
icon	菜单图标	query	false	string
isCache	是否缓存（0缓存 1不缓存）	query	false	string
isFrame	是否为外链（0是 1否）	query	false	string
menuId	菜单ID	query	false	integer(int64)
menuName	菜单名称	query	false	string
menuType	类型（M目录 C菜单 F按钮）	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父菜单ID	query	false	integer(int64)
parentName	父菜单名称	query	false	string
path	路由地址	query	false	string
perms	权限字符串	query	false	string
query	路由参数	query	false	string
remark	备注	query	false	string
status	菜单状态（0显示 1隐藏）	query	false	string
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
visible	显示状态（0显示 1隐藏）	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据菜单编号获取详细信息

接口地址:/system/tenant/menu/{menuId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
menuId	menuId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除菜单

接口地址:/system/tenant/menu/{menuId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
menuId	menuId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

租户-角色

新增角色

接口地址:/system/tenant/role

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "createBy": "",
  "createTime": "",
  "dataScope": "",
  "delFlag": "",
  "deptCheckStrictly": true,
  "deptIds": "",
  "flag": true,
  "menuCheckStrictly": true,
  "menuIds": "",
  "remark": "",
  "roleId": "",
  "roleKey": "",
  "roleName": "",
  "roleSort": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
role	角色表	body	true	TenantRole对象	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改保存角色

接口地址:/system/tenant/role

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "createBy": "",
  "createTime": "",
  "dataScope": "",
  "delFlag": "",
  "deptCheckStrictly": true,
  "deptIds": "",
  "flag": true,
  "menuCheckStrictly": true,
  "menuIds": "",
  "remark": "",
  "roleId": "",
  "roleKey": "",
  "roleName": "",
  "roleSort": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
role	角色表	body	true	TenantRole对象	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询已分配用户角色列表

接口地址:/system/tenant/role/authUser/allocatedList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.tenantId	租户ID	query	false	integer(int64)
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].tenantId	租户ID	query	false	integer(int64)
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

取消授权用户

接口地址:/system/tenant/role/authUser/cancel

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "roleId": "",
  "tenantId": "",
  "userId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
userRole	用户和角色关联	body	true	TenantUserRole对象	TenantUserRole对象
roleId	角色ID		false	string
tenantId	租户ID		false	string
userId	用户ID		false	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量取消授权用户

接口地址:/system/tenant/role/authUser/cancelAll

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
roleId	roleId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
userIds	userIds	query	false	array	integer

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

批量选择用户授权

接口地址:/system/tenant/role/authUser/selectAll

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
roleId	roleId	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
userIds	userIds	query	false	array	integer

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询未分配用户角色列表

接口地址:/system/tenant/role/authUser/unallocatedList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
avatar	用户头像	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.ancestors	祖级列表	query	false	string
dept.createBy	创建人	query	false	string
dept.createTime	创建时间	query	false	string(date-time)
dept.delFlag	删除标志（0代表存在 2代表删除）	query	false	string
dept.deptId	部门ID	query	false	integer(int64)
dept.deptName	部门名称	query	false	string
dept.deptType	部门类型	query	false	string
dept.email	邮箱	query	false	string
dept.leader	负责人	query	false	string
dept.orderNum	显示顺序	query	false	string
dept.parentId	父部门ID	query	false	integer(int64)
dept.parentName	父部门名称	query	false	string
dept.phone	联系电话	query	false	string
dept.status	部门状态	query	false	string
dept.tenantId	租户ID	query	false	integer(int64)
dept.updateBy	更新人	query	false	string
dept.updateTime	更新时间	query	false	string(date-time)
deptId	部门ID	query	false	integer(int64)
email	用户邮箱	query	false	string
loginDate	最后登录时间	query	false	string(date-time)
loginIp	最后登录IP	query	false	string
nickName	用户昵称	query	false	string
params	请求参数	query	false	object
password	密码	query	false	string
phonenumber	手机号码	query	false	string
postIds	岗位组	query	false	array	integer
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleIds	角色组	query	false	array	integer
roles[0].admin		query	false	boolean
roles[0].createBy	创建人	query	false	string
roles[0].createTime	创建时间	query	false	string(date-time)
roles[0].dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
roles[0].delFlag	删除标志（0代表存在 2代表删除）	query	false	string
roles[0].deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].deptIds	部门组（数据权限）	query	false	array	integer
roles[0].flag	用户是否存在此角色标识默认不存在	query	false	boolean
roles[0].menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
roles[0].menuIds	菜单组	query	false	array	integer
roles[0].remark	备注	query	false	string
roles[0].roleId	角色ID	query	false	integer(int64)
roles[0].roleKey	角色权限	query	false	string
roles[0].roleName	角色名称	query	false	string
roles[0].roleSort	角色排序	query	false	string
roles[0].status	角色状态（0正常 1停用）	query	false	string
roles[0].tenantId	租户ID	query	false	integer(int64)
roles[0].updateBy	更新人	query	false	string
roles[0].updateTime	更新时间	query	false	string(date-time)
sex	用户性别	query	false	string
status	帐号状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)
userId	用户ID	query	false	integer(int64)
userName	用户账号	query	false	string
userType	用户类型（00：系统用户，01：注册用户，02：租户超管）	query	false	string

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

修改保存数据权限

接口地址:/system/tenant/role/dataScope

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "admin": true,
  "createBy": "",
  "createTime": "",
  "dataScope": "",
  "delFlag": "",
  "deptCheckStrictly": true,
  "deptIds": "",
  "flag": true,
  "menuCheckStrictly": true,
  "menuIds": "",
  "remark": "",
  "roleId": "",
  "roleKey": "",
  "roleName": "",
  "roleSort": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
role	角色表	body	true	TenantRole对象	TenantRole对象
admin			false	boolean
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）		false	string
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
deptIds	部门组（数据权限）		false	string
flag	用户是否存在此角色标识默认不存在		false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）		false	boolean
menuIds	菜单组		false	string
remark	备注		false	string
roleId	角色ID		false	string
roleKey	角色权限		false	string
roleName	角色名称		false	string
roleSort	角色排序		false	string
status	角色状态（0正常 1停用）		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

导出角色列表

接口地址:/system/tenant/role/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
deptIds	部门组（数据权限）	query	false	array	integer
flag	用户是否存在此角色标识默认不存在	query	false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
menuIds	菜单组	query	false	array	integer
params	请求参数	query	false	object
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleKey	角色权限	query	false	string
roleName	角色名称	query	false	string
roleSort	角色排序	query	false	string
status	角色状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询角色列表

接口地址:/system/tenant/role/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
admin		query	false	boolean
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
dataScope	数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）	query	false	string
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptCheckStrictly	部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
deptIds	部门组（数据权限）	query	false	array	integer
flag	用户是否存在此角色标识默认不存在	query	false	boolean
menuCheckStrictly	菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）	query	false	boolean
menuIds	菜单组	query	false	array	integer
params	请求参数	query	false	object
remark	备注	query	false	string
roleId	角色ID	query	false	integer(int64)
roleKey	角色权限	query	false	string
roleName	角色名称	query	false	string
roleSort	角色排序	query	false	string
status	角色状态（0正常 1停用）	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	TableDataInfo
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
rows	array
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"msg": "",
	"rows": [],
	"total": 0
}

获取角色选择框列表

接口地址:/system/tenant/role/optionselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除角色

接口地址:/system/tenant/role/{roleIds}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleIds	roleIds	path	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

根据角色编号获取详细信息

接口地址:/system/tenant/role/{roleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleId	roleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

租户-部门

新增部门

接口地址:/system/tenant/dept

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "ancestors": "",
  "children": [
    {
      "ancestors": "",
      "children": [
        {
          "ancestors": "",
          "children": [
            {}
          ],
          "createBy": "",
          "createTime": "",
          "delFlag": "",
          "deptId": "",
          "deptName": "",
          "deptType": "",
          "email": "",
          "leader": "",
          "orderNum": "",
          "parentId": "",
          "parentName": "",
          "phone": "",
          "status": "",
          "tenantId": "",
          "updateBy": "",
          "updateTime": ""
        }
      ],
      "createBy": "",
      "createTime": "",
      "delFlag": "",
      "deptId": "",
      "deptName": "",
      "deptType": "",
      "email": "",
      "leader": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "phone": "",
      "status": "",
      "tenantId": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "deptId": "",
  "deptName": "",
  "deptType": "",
  "email": "",
  "leader": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "phone": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dept	部门表	body	true	TenantDept对象	TenantDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	TenantDept对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

修改部门

接口地址:/system/tenant/dept

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "ancestors": "",
  "children": [
    {
      "ancestors": "",
      "children": [
        {
          "ancestors": "",
          "children": [
            {}
          ],
          "createBy": "",
          "createTime": "",
          "delFlag": "",
          "deptId": "",
          "deptName": "",
          "deptType": "",
          "email": "",
          "leader": "",
          "orderNum": "",
          "parentId": "",
          "parentName": "",
          "phone": "",
          "status": "",
          "tenantId": "",
          "updateBy": "",
          "updateTime": ""
        }
      ],
      "createBy": "",
      "createTime": "",
      "delFlag": "",
      "deptId": "",
      "deptName": "",
      "deptType": "",
      "email": "",
      "leader": "",
      "orderNum": "",
      "parentId": "",
      "parentName": "",
      "phone": "",
      "status": "",
      "tenantId": "",
      "updateBy": "",
      "updateTime": ""
    }
  ],
  "createBy": "",
  "createTime": "",
  "delFlag": "",
  "deptId": "",
  "deptName": "",
  "deptType": "",
  "email": "",
  "leader": "",
  "orderNum": "",
  "parentId": "",
  "parentName": "",
  "phone": "",
  "status": "",
  "tenantId": "",
  "updateBy": "",
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
dept	部门表	body	true	TenantDept对象	TenantDept对象
ancestors	祖级列表		false	string
children	子部门		false	array	TenantDept对象
createBy	创建人		false	string
createTime	创建时间		false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）		false	string
deptId	部门ID		false	string
deptName	部门名称		false	string
deptType	部门类型		false	string
email	邮箱		false	string
leader	负责人		false	string
orderNum	显示顺序		false	string
parentId	父部门ID		false	string
parentName	父部门名称		false	string
phone	联系电话		false	string
status	部门状态		false	string
tenantId	租户ID		false	string
updateBy	更新人		false	string
updateTime	更新时间		false	string(date-time)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取部门下拉树列表

接口地址:/system/tenant/dept/getNormalDeptTree

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权认证	header	true	string
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取部门列表

接口地址:/system/tenant/dept/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
ancestors	祖级列表	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptId	部门ID	query	false	integer(int64)
deptName	部门名称	query	false	string
deptType	部门类型	query	false	string
email	邮箱	query	false	string
leader	负责人	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父部门ID	query	false	integer(int64)
parentName	父部门名称	query	false	string
phone	联系电话	query	false	string
status	部门状态	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询部门列表（排除节点）

接口地址:/system/tenant/dept/list/exclude/{deptId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

加载对应角色部门列表树

接口地址:/system/tenant/dept/roleDeptTreeselect/{roleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
roleId	roleId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

获取部门下拉树列表

接口地址:/system/tenant/dept/treeselect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
ancestors	祖级列表	query	false	string
createBy	创建人	query	false	string
createTime	创建时间	query	false	string(date-time)
delFlag	删除标志（0代表存在 2代表删除）	query	false	string
deptId	部门ID	query	false	integer(int64)
deptName	部门名称	query	false	string
deptType	部门类型	query	false	string
email	邮箱	query	false	string
leader	负责人	query	false	string
orderNum	显示顺序	query	false	string
params	请求参数	query	false	object
parentId	父部门ID	query	false	integer(int64)
parentName	父部门名称	query	false	string
phone	联系电话	query	false	string
status	部门状态	query	false	string
tenantId	租户ID	query	false	integer(int64)
tenant_id	租户ID	header	false	integer(int64)
updateBy	更新人	query	false	string
updateTime	更新时间	query	false	string(date-time)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

根据部门编号获取详细信息

接口地址:/system/tenant/dept/{deptId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

删除部门

接口地址:/system/tenant/dept/{deptId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权认证	header	true	string
deptId	deptId	path	true	integer(int64)
tenant_id	租户ID	header	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

暂无

响应示例:

752 KiB Raw Blame History Unescape Escape

认证模块接口文档

app-token-controller

appLogin

appLogout

appPhoneLogin

appRefresh

register

tenant-token-controller

login

logout

refresh

register

token-controller

login

logout

refresh

register

文件处理模块接口文档

file-controller

downLoad

单个文件上传

批量文件上传

pre-file-controller

downLoad

单个文件上传

批量文件上传

系统模块接口文档

体育馆VIP卡

新增体育馆VIP卡

修改体育馆VIP卡

查询体育馆VIP卡列表

VIP卡上下架

查询体育馆VIP卡详细信息

删除体育馆VIP卡

体育馆场地

新增体育馆场地

修改体育馆场地

场地启用与停用

查询体育馆场地列表

获取体育馆场地详细信息

删除体育馆场地

体育馆场馆

新增体育馆场馆

修改体育馆场馆

查询体育馆场馆列表

场馆启用与停用

获取体育馆场馆详细信息

删除体育馆场馆

体育馆基础

获取体育馆基础详细信息

新增体育馆基础

修改体育馆基础

获取行政区域

查询体育馆基础列表

删除体育馆基础

前台体育馆VIP卡

前台查询体育馆VIP卡列表

前台查询体育馆VIP卡详细信息

前台体育馆场馆

前台获取体育馆场馆详细信息

前台收藏

添加收藏

删除收藏

查询我的收藏列表

前台文章管理

前台获取用户服务协议和隐私政策（contentType 1：用户服务协议，2：隐私政策）

前台获取体育馆展馆概况

前台查询文章列表

前台获取文章详细信息

前台点赞

添加点赞

删除点赞

查询我的点赞

前台用户VIP使用

前台新增用户VIP使用（类似订单）

前台查询用户VIP使用（类似订单）列表

获取用户VIP已使用金额

vip使用退款

前台获取用户VIP使用（类似订单）详细信息

752 KiB

Raw Blame History