智慧酒店项目

Version	Update Time	Status	Author	Description
0.0.1	2022-07-27 09:50:00	创建文档	codingliang	初始化接口文档

Version

Update Time

Status

Author

Description

0.0.1

2022-07-27 09:50:00

创建文档

codingliang

初始化接口文档

1. 指纹、IC卡管理

1.1. IC卡分页查询

URL: http://192.168.161.34:8089/ihotel/condition/ic/queryInfo/{roomNo}

Type: GET

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

Description: IC卡分页查询

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter	Type	Description	Required	Since
roomNo	string	房间编号	true	-

Parameter

Type

Description

Required

Since

roomNo

string

房间编号

true

Query-parameters:

Parameter	Type	Description	Required	Since
curPage	int32	当前页，默认1	false	-
pageSize	int32	每页大小，默认10	false	-
orderField	string	排序字段，可选择值参考返回结果	false	-
order	string	排序方式，可选值：asc、desc	false	-
keyWord	string	指纹编码/IC卡号/姓名	false	-
userType	string	用户类型	false	-
roomNo	string	房间编号	false	-
createTime	string	创建时间	false	-

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

keyWord

string

指纹编码/IC卡号/姓名

false

userType

string

用户类型

false

roomNo

string

房间编号

false

createTime

string

创建时间

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/ic/queryInfo/kmfkl1?orderField=rxhfsg&userType=t94ym7&pageSize=10&createTime=2023-06-21 16:57:36&order=0r87ht&keyWord=b4gsuw&curPage=1

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.2. IC卡查询-详情

URL: http://192.168.161.34:8089/ihotel/condition/ic/queryICInfoById

Type: GET

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

Description: IC卡查询-详情

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter	Type	Description	Required	Since
id	int64	记录ID	false	-

Parameter

Type

Description

Required

Since

int64

记录ID

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/ic/queryICInfoById?id=826

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.3. IC卡新增

URL: http://192.168.161.34:8089/ihotel/condition/ic/add

Type: POST

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

Description: IC卡新增

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter	Type	Description	Required	Since
id	int64	编号	false	-
cardNumber	string	IC卡号	false	-
roomNo	string	房间编号	false	-
holderName	string	持卡人姓名	false	-
userType	string	用户类型	false	-
takeTime	string	生效时间	false	-
failureTime	string	失效时间	false	-
createTime	string	创建时间	false	-
statu	string	状态 0 失效 1 生效	false	-
lockUserId	string	锁用户ID（调用青松接口返回的id）	false	-

Parameter

Type

Description

Required

Since

int64

编号

false

cardNumber

string

IC卡号

false

roomNo

string

房间编号

false

holderName

string

持卡人姓名

false

userType

string

用户类型

false

takeTime

string

生效时间

false

failureTime

string

失效时间

false

createTime

string

创建时间

false

statu

string

状态 0 失效 1 生效

false

lockUserId

string

锁用户ID（调用青松接口返回的id）

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/ic/add --data '{
  "id": 449,
  "cardNumber": "7dyki5",
  "roomNo": "4w6qzy",
  "holderName": "弘文.潘",
  "userType": "d61r9c",
  "takeTime": "2023-06-21 16:57:36",
  "failureTime": "2023-06-21 16:57:36",
  "createTime": "2023-06-21 16:57:36",
  "statu": "nzftlg",
  "lockUserId": "52"
}'

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.4. IC卡修改

URL: http://192.168.161.34:8089/ihotel/condition/ic/update

Type: POST

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

Description: IC卡修改

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter	Type	Description	Required	Since
id	int64	编号	false	-
cardNumber	string	IC卡号	false	-
roomNo	string	房间编号	false	-
holderName	string	持卡人姓名	false	-
userType	string	用户类型	false	-
takeTime	string	生效时间	false	-
failureTime	string	失效时间	false	-
createTime	string	创建时间	false	-
statu	string	状态 0 失效 1 生效	false	-
lockUserId	string	锁用户ID（调用青松接口返回的id）	false	-

Parameter

Type

Description

Required

Since

int64

编号

false

cardNumber

string

IC卡号

false

roomNo

string

房间编号

false

holderName

string

持卡人姓名

false

userType

string

用户类型

false

takeTime

string

生效时间

false

failureTime

string

失效时间

false

createTime

string

创建时间

false

statu

string

状态 0 失效 1 生效

false

lockUserId

string

锁用户ID（调用青松接口返回的id）

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/ic/update --data '{
  "id": 257,
  "cardNumber": "afixeg",
  "roomNo": "mew7z0",
  "holderName": "弘文.潘",
  "userType": "o92w7h",
  "takeTime": "2023-06-21 16:57:36",
  "failureTime": "2023-06-21 16:57:36",
  "createTime": "2023-06-21 16:57:36",
  "statu": "62j63l",
  "lockUserId": "52"
}'

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.5. IC卡解绑

URL: http://192.168.161.34:8089/ihotel/condition/ic/unbundIC

Type: GET

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

Description: IC卡解绑

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter	Type	Description	Required	Since
statu	string	状态 0 已解绑 1 未解绑	false	-
id	int64	No comments found.	false	-

Parameter

Type

Description

Required

Since

statu

string

状态 0 已解绑 1 未解绑

false

int64

No comments found.

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/ic/unbundIC?statu=abkycd&id=217

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.6. IC卡导出详情

URL: http://192.168.161.34:8089/ihotel/condition/downLoadICInfo

Type: GET

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

Description: IC卡导出详情

Query-parameters:

Parameter	Type	Description	Required	Since
keyWord	string	指纹编码/IC卡号/姓名	false	-
userType	string	用户类型	false	-
roomNo	string	房间编号	false	-
createTime	string	创建时间	false	-

Parameter

Type

Description

Required

Since

keyWord

string

指纹编码/IC卡号/姓名

false

userType

string

用户类型

false

roomNo

string

房间编号

false

createTime

string

创建时间

false

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/condition/downLoadICInfo?keyWord=56iz1y&roomNo=hn5pu6&createTime=2023-06-21 16:57:36&userType=aok2ut

Response-example:

Doesn't return a value.

1.7. 指纹分页查询

URL: http://192.168.161.34:8089/ihotel/condition/fingerprint/queryInfo/{roomNo}

Type: GET

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

Description: 指纹分页查询

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter	Type	Description	Required	Since
roomNo	string	房间编号	true	-

Parameter

Type

Description

Required

Since

roomNo

string

房间编号

true

Query-parameters:

Parameter	Type	Description	Required	Since
curPage	int32	当前页，默认1	false	-
pageSize	int32	每页大小，默认10	false	-
orderField	string	排序字段，可选择值参考返回结果	false	-
order	string	排序方式，可选值：asc、desc	false	-
keyWord	string	指纹编码/IC卡号/姓名	false	-
userType	string	用户类型	false	-
roomNo	string	房间编号	false	-
createTime	string	创建时间	false	-

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

keyWord

string

指纹编码/IC卡号/姓名

false

userType

string

用户类型

false

roomNo

string

房间编号

false

createTime

string

创建时间

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/fingerprint/queryInfo/ygx2st?userType=sv7l4p&order=rpu15e&keyWord=658e66&pageSize=10&orderField=9zi5mt&createTime=2023-06-21 16:57:36&curPage=1

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.8.

URL: http://192.168.161.34:8089/ihotel/condition/PowerOnOff

Type: GET

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

Description: null

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	null	true	-

Header

Type

Description

Required

Since

admin_token

string

null

true

Path-parameters:

Parameter	Type	Description	Required	Since
electric	string	No comments found.	true	-

Parameter

Type

Description

Required

Since

electric

string

No comments found.

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/PowerOnOff?electric=8wvq0c

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.9. 指纹查询-详情

URL: http://192.168.161.34:8089/ihotel/condition/fingerprint/queryInfoById

Type: GET

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

Description: 指纹查询-详情

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter	Type	Description	Required	Since
id	int64	记录ID	false	-

Parameter

Type

Description

Required

Since

int64

记录ID

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/fingerprint/queryInfoById?id=407

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.10. 指纹新增

URL: http://192.168.161.34:8089/ihotel/condition/fingerprint/add

Type: POST

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

Description: 指纹新增

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter	Type	Description	Required	Since
id	int64	编号	false	-
fingerprintNumber	string	指纹编码	false	-
roomNo	string	房间编号	false	-
holderName	string	指纹所有者	false	-
userType	string	用户类型	false	-
takeTime	string	生效时间	false	-
failureTime	string	失效时间	false	-
createTime	string	创建时间	false	-
statu	string	状态 0 失效 1 生效	false	-
lockUserId	string	锁用户ID（调用青松接口返回的id）	false	-

Parameter

Type

Description

Required

Since

int64

编号

false

fingerprintNumber

string

指纹编码

false

roomNo

string

房间编号

false

holderName

string

指纹所有者

false

userType

string

用户类型

false

takeTime

string

生效时间

false

failureTime

string

失效时间

false

createTime

string

创建时间

false

statu

string

状态 0 失效 1 生效

false

lockUserId

string

锁用户ID（调用青松接口返回的id）

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/fingerprint/add --data '{
  "id": 513,
  "fingerprintNumber": "7unkzl",
  "roomNo": "pu38ww",
  "holderName": "弘文.潘",
  "userType": "p638mo",
  "takeTime": "2023-06-21 16:57:36",
  "failureTime": "2023-06-21 16:57:36",
  "createTime": "2023-06-21 16:57:36",
  "statu": "ev8qjl",
  "lockUserId": "52"
}'

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.11. 指纹修改

URL: http://192.168.161.34:8089/ihotel/condition/fingerprint/update

Type: POST

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

Description: 指纹修改

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter	Type	Description	Required	Since
id	int64	编号	false	-
fingerprintNumber	string	指纹编码	false	-
roomNo	string	房间编号	false	-
holderName	string	指纹所有者	false	-
userType	string	用户类型	false	-
takeTime	string	生效时间	false	-
failureTime	string	失效时间	false	-
createTime	string	创建时间	false	-
statu	string	状态 0 失效 1 生效	false	-
lockUserId	string	锁用户ID（调用青松接口返回的id）	false	-

Parameter

Type

Description

Required

Since

int64

编号

false

fingerprintNumber

string

指纹编码

false

roomNo

string

房间编号

false

holderName

string

指纹所有者

false

userType

string

用户类型

false

takeTime

string

生效时间

false

failureTime

string

失效时间

false

createTime

string

创建时间

false

statu

string

状态 0 失效 1 生效

false

lockUserId

string

锁用户ID（调用青松接口返回的id）

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/fingerprint/update --data '{
  "id": 604,
  "fingerprintNumber": "rp3ru7",
  "roomNo": "ghpi7t",
  "holderName": "弘文.潘",
  "userType": "n9ggwu",
  "takeTime": "2023-06-21 16:57:36",
  "failureTime": "2023-06-21 16:57:36",
  "createTime": "2023-06-21 16:57:36",
  "statu": "0la3dr",
  "lockUserId": "52"
}'

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.12. 指纹解绑

URL: http://192.168.161.34:8089/ihotel/condition/fingerprint/unbundFingerprint

Type: GET

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

Description: 指纹解绑

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter	Type	Description	Required	Since
statu	string	状态 0 已解绑 1 未解绑	false	-
id	int64	记录ID	false	-

Parameter

Type

Description

Required

Since

statu

string

状态 0 已解绑 1 未解绑

false

int64

记录ID

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/condition/fingerprint/unbundFingerprint?statu=ryh9d3&id=884

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

1.13. 指纹导出详情

URL: http://192.168.161.34:8089/ihotel/condition/downLoadFingerprintInfo

Type: GET

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

Description: 指纹导出详情

Query-parameters:

Parameter	Type	Description	Required	Since
keyWord	string	指纹编码/IC卡号/姓名	false	-
userType	string	用户类型	false	-
roomNo	string	房间编号	false	-
createTime	string	创建时间	false	-

Parameter

Type

Description

Required

Since

keyWord

string

指纹编码/IC卡号/姓名

false

userType

string

用户类型

false

roomNo

string

房间编号

false

createTime

string

创建时间

false

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/condition/downLoadFingerprintInfo?keyWord=1lejfs&roomNo=lby1xy&userType=zdki6r&createTime=2023-06-21 16:57:36

Response-example:

Doesn't return a value.

2. 酒店管理员

2.1. 管理员登录

URL: http://192.168.161.34:8089/ihotel/hotelAdmin/login

Type: POST

Author: codingliang

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

Description: 注意：密码使用提供的公钥进行RSA加密后传输
公钥：MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDMOcPB06u5yKyQsPjfVWiWgbEIrd14kiXNNihciaVKb6HnkQvq7zpQuZ80WEX94spnUMI3iOAl/GmIvHrpGwcbB4hJbznm+PajiwnUSPuCCXA68YJF640cJKb/8KeM7WVz69OFkIEPHhVxOy4FFF5QWe/kt6zOZ19HmE+ak+5x/QIDAQAB

Body-parameters:

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

Parameter

Type

Description

Required

Since

username

string

用户名

true

password

string

密码

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://192.168.161.34:8089/ihotel/hotelAdmin/login --data '{
  "username": "弘文.潘",
  "password": "vomvo4"
}'

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─userName	string	用户姓名	-
└─userType	string	用户类别 1管理员、2普通用户	-
└─userIdentity	string	用户身份只有userType为2时该字段才有值 0其他、1学生、4教职工、5校友	-
└─telPhone	string	手机号码	-
└─headImage	string	头像	-
└─token	string	用户token	-
└─tokenTtl	int64	token过期时间	-
└─authority	string	权限数组	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─userName

string

用户姓名

└─userType

string

用户类别 1管理员、2普通用户

└─userIdentity

string

用户身份只有userType为2时该字段才有值 0其他、1学生、4教职工、5校友

└─telPhone

string

手机号码

└─headImage

string

头像

└─token

string

用户token

└─tokenTtl

int64

token过期时间

└─authority

string

权限数组

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "userName": "弘文.潘",
    "userType": "m2y6by",
    "userIdentity": "tyvv6g",
    "telPhone": "13938323718",
    "headImage": "bp5t1u",
    "token": "pfvtg4",
    "tokenTtl": 943,
    "authority": "ff29nb"
  }
}

2.2. 管理员列表

URL: http://192.168.161.34:8089/ihotel/hotelAdmin/list

Type: GET

Author: codingliang

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

Description: 管理员列表

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter	Type	Description	Required	Since
keyword	string	关键字搜索，支持手机号和姓名搜索	false	-
curPage	int32	当前页，默认1	false	-
pageSize	int32	每页大小，默认10	false	-
orderField	string	排序字段，可选择值参考返回结果	false	-
order	string	排序方式，可选值：asc、desc	false	-
telPhone	string	No comments found.	false	-
userType	string	No comments found.	false	-

Parameter

Type

Description

Required

Since

keyword

string

关键字搜索，支持手机号和姓名搜索

false

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

telPhone

string

No comments found.

false

userType

string

No comments found.

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/hotelAdmin/list?keyword=qa00oy&telPhone=13938323718&curPage=1&order=1msvbh&orderField=darblc&userType=i603u5&pageSize=10

Response-fields:

Field	Type	Description	Since
success	boolean	接口调用结果标识	-
message	string	接口调用结果信息	-
code	string	接口调用业务码	-
data	object	接口调用返回数据	-
└─totalCount	int32	总记录数	-
└─pageSize	int32	每页记录数	-
└─totalPage	int32	总页数	-
└─currPage	int32	当前页数	-
└─list	array	列表数据	-
└─id	int64	id	-
└─phone	string	手机号码登录账号	-
└─username	string	员工姓名	-
└─adminType	string	管理员类别 1超级管理员、2普通管理员	-
└─password	string	密码登录密码，新增时不能为空，使用RSA加密后传输	-
└─statu	string	状态 0冻结、1正常	-
└─authority	string	权限字符串	-

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─phone

string

手机号码登录账号

└─username

string

员工姓名

└─adminType

string

管理员类别 1超级管理员、2普通管理员

└─password

string

密码登录密码，新增时不能为空，使用RSA加密后传输

└─statu

string

状态 0冻结、1正常

└─authority

string

权限字符串

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 766,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 608,
        "phone": "13938323718",
        "username": "弘文.潘",
        "adminType": "977x03",
        "password": "kke18e",
        "statu": "djm98v",
        "authority": "krjvjq"
      }
    ]
  }
}

2.3. 新增管理员

URL: http://192.168.161.34:8089/ihotel/hotelAdmin/add

Type: POST

Author: codingliang

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

Description: 新增管理员

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	管理员token	true	-

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter	Type	Description	Required	Since
id	int64	id	false	-
phone	string	手机号码登录账号	true	-
username	string	员工姓名	true	-
adminType	string	管理员类别 1超级管理员、2普通管理员	true	-
password	string	密码登录密码，新增时不能为空，使用RSA加密后传输	false	-
statu	string	状态 0冻结、1正常	true	-
authority	array	权限字符数组	false	-

Parameter

Type

Description

Required

Since

int64

false

phone

string

手机号码登录账号

true

username

string

员工姓名

true

adminType

string

管理员类别 1超级管理员、2普通管理员

true

password

string

密码登录密码，新增时不能为空，使用RSA加密后传输

false

statu

string

状态 0冻结、1正常

true

authority

array

权限字符数组

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/hotelAdmin/add --data '{
  "id": 677,
  "phone": "13938323718",
  "username": "弘文.潘",
  "adminType": "xpqg2m",
  "password": "akmkwb",
  "statu": "q95cou",
  "authority": [
    "becex5"
  ]
}'

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "vdv5o5"
}

2.4. 修改管理员

URL: http://192.168.161.34:8089/ihotel/hotelAdmin/update

Type: PUT

Author: codingliang

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

Description: 修改管理员

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	null	true	-

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter	Type	Description	Required	Since
id	int64	id	false	-
phone	string	手机号码登录账号	true	-
username	string	员工姓名	true	-
adminType	string	管理员类别 1超级管理员、2普通管理员	true	-
password	string	密码登录密码，新增时不能为空，使用RSA加密后传输	false	-
statu	string	状态 0冻结、1正常	true	-
authority	array	权限字符数组	false	-

Parameter

Type

Description

Required

Since

int64

false

phone

string

手机号码登录账号

true

username

string

员工姓名

true

adminType

string

管理员类别 1超级管理员、2普通管理员

true

password

string

密码登录密码，新增时不能为空，使用RSA加密后传输

false

statu

string

状态 0冻结、1正常

true

authority

array

权限字符数组

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/hotelAdmin/update --data '{
  "id": 9,
  "phone": "13938323718",
  "username": "弘文.潘",
  "adminType": "fd2ef0",
  "password": "8n1n2d",
  "statu": "51ehyw",
  "authority": [
    "art553"
  ]
}'

Response-fields:

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

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "smvj5b"
}

2.5. 修改密码

URL: http://192.168.161.34:8089/ihotel/hotelAdmin/updatePassword

Type: PUT

Author: codingliang

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

Description: 超级管理员可以修改所有管理员的密码，普通管理员只能修改本人密码。超级管理员修改他人密码时必须要传adminId。

Request-headers:

Header	Type	Description	Required	Since
admin_token	string	No comments found.	true	-

Header

Type

Description

Required

Since

admin_token

string

No comments found.

true

Body-parameters:

Parameter

Type

Description

Required

Since

adminId

int64

管理员id，超级管理员修改普通管理员密码时不能为空

false

password

string

密码，密码使用公钥加密后传输

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/hotelAdmin/updatePassword --data '{
  "adminId": 453,
  "password": "p29ivm"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "3g0p2j"
}

2.6. 删除管理员

URL: http://192.168.161.34:8089/ihotel/hotelAdmin/delete

Type: DELETE

Author: codingliang

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

Description: 删除管理员

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/hotelAdmin/delete --data '[
  692,
  635
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "4p1ehf"
}

3. 酒店订单

3.1. 获取请求令牌

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/submit/token

Type: GET

Author: codingliang

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

Description: 获取请求令牌

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Request-example:

curl -X GET -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/submit/token

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─submitToken

string

提交token

└─expire

int64

过期时间单位:ms

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "submitToken": "sc0th8",
    "expire": 608
  }
}

3.2. 确认订单

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/confirm

Type: GET

Author: codingliang

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

Description: 确认订单

Query-parameters:

Parameter

Type

Description

Required

Since

startTime

string

入住时间 yyyy-MM-dd

true

endTime

string

离店时间 yyyy-MM-dd HH

true

roomTypeId

int64

房型id

true

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/confirm?roomTypeId=801&endTime=2023-06-21&startTime=2023-06-21

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─startTime

string

入住时间 yyyy-MM-dd HH:mm:ss

└─endTime

string

离店时间 yyyy-MM-dd HH:mm:ss

└─nums

int32

入住天数

└─roomTypeId

int64

房间类型id

└─roomTypeName

string

房间类型名称

└─freeNum

int32

可预定房间数量，为0表示不可定

└─discountPrice

number

优惠价格单位：元

└─deposit

number

押金单位：元

└─totalAmount

number

需付总金额（优惠价格+押金）*nums

└─priceOfWater

number

水费单位：元/吨

└─priceOfElectric

number

电费单位：元/度

└─freeQuotaOfWater

number

水免费额度单位：吨

└─freeQuotaOfElectric

number

电免费额度单位：度

└─freeTotal

number

水电免费额度总金额单位：元

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "startTime": "2023-06-21 16:57:37",
    "endTime": "2023-06-21 16:57:37",
    "nums": 636,
    "roomTypeId": 445,
    "roomTypeName": "弘文.潘",
    "freeNum": 803,
    "discountPrice": 343,
    "deposit": 174,
    "totalAmount": 741,
    "priceOfWater": 653,
    "priceOfElectric": 858,
    "freeQuotaOfWater": 179,
    "freeQuotaOfElectric": 187,
    "freeTotal": 346
  }
}

3.3. 提交订单

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/submit

Type: POST

Author: codingliang

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

Description: 提交订单

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户卡号

true

request_token

string

请求令牌，从【获取请求令牌】接口获取

true

Body-parameters:

Parameter

Type

Description

Required

Since

enableStartTime

string

入住时间 yyyy-MM-dd HH:mm:ss

true

enableEndTime

string

离店时间 yyyy-MM-dd HH:mm:ss

true

roomTypeId

int64

房间类型id

true

payAmount

number

需付总金额，用于订单验价

true

userName

string

联系人姓名

true

userPhone

string

联系人电话

true

mayIntoTime

string

预计到店时间 yyyy-MM-dd HH:mm:ss

true

remark

string

备注说明

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'user_token' -H 'request_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/submit --data '{
  "enableStartTime": "2023-06-21 16:57:37",
  "enableEndTime": "2023-06-21 16:57:37",
  "roomTypeId": 834,
  "payAmount": 767,
  "userName": "弘文.潘",
  "userPhone": "13938323718",
  "mayIntoTime": "2023-06-21 16:57:37",
  "remark": "mr66yc"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─payAmount

number

实际支付金额，如果实际支付金额为0，则不需要调用支付接口，直接跳转到支付成功页面

└─payUrl

string

支付地址

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "orderId": 552,
    "payAmount": 591,
    "payUrl": "www.xn---xn--674a-9y5v.org"
  }
}

3.4. 订单列表【用户端】

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/page

Type: GET

Author: codingliang

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

Description: 订单列表【用户端】

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

orderId

int64

订单id

false

keyWord

string

关键字(订单号、房间号)

false

userFlag

string

订单用户标识

false

userName

string

用户姓名

false

userPhone

string

用户手机号码

false

roomNo

string

房间编号

false

roomTypeId

int64

房型id

false

statu

string

状态 0已取消、1待支付、2待入住、3已入住、4-1退款中、4-2欠款待支付、5已完成

false

enableStartTime

string

最早入住时间最早可入住时间 yyyy-MM-dd HH:mm:ss

false

enableEndTime

string

最晚离店时间最晚要离店时间 yyyy-MM-dd HH:mm:ss

false

payTime1

string

支付时间开始 yyyy-MM-dd HH:mm:ss

false

payTime2

string

支付时间结束 yyyy-MM-dd HH:mm:ss

false

createTime1

string

创建时间开始 yyyy-MM-dd HH:mm:ss

false

createTime2

string

创建时间结束 yyyy-MM-dd HH:mm:ss

false

deleteFlag

string

删除标识 1正常，0删除

false

Request-example:

curl -X GET -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/page?statu=pqrtbw&createTime1=2023-06-21 16:57:37&createTime2=2023-06-21 16:57:37&orderId=209&order=nyyll2&deleteFlag=f9glx3&userName=弘文.潘&roomNo=19qmg1&curPage=1&userPhone=13938323718&roomTypeId=597&pageSize=10&payTime2=2023-06-21 16:57:37&enableStartTime=2023-06-21 16:57:37&enableEndTime=2023-06-21 16:57:37&payTime1=2023-06-21 16:57:37&orderField=ucuoho&userFlag=k8e850&keyWord=pocbvk

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

订单id

└─orderNo

string

订单编号

└─payAmount

number

实际支付金额

└─createTime

string

下单时间

└─enableStartTime

string

入住时间

└─enableEndTime

string

离店时间

└─orderStatu

string

订单状态 0已取消、1待支付、2待入住、3已入住、4待结账、5已完成

└─bizStatu

string

业务状态 0待处理、1发起退款、2发起结账支付、3退款或结账支付完成，订单状态为4的时候，显示该状态

└─roomTypeId

int64

房型id

└─roomTypeName

string

房型名称

└─roomTypeMasterImg

string

房型主图

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 876,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 116,
        "orderNo": "i0he7s",
        "payAmount": 662,
        "createTime": "2023-06-21 16:57:37",
        "enableStartTime": "2023-06-21 16:57:37",
        "enableEndTime": "2023-06-21 16:57:37",
        "orderStatu": "3quux5",
        "bizStatu": "x4xifg",
        "roomTypeId": 140,
        "roomTypeName": "弘文.潘",
        "roomTypeMasterImg": "hkzwcu"
      }
    ]
  }
}

3.5. 订单列表【管理端】

URL: http://192.168.161.34:8089/ihotel/hotelOrder/admin/order/page

Type: GET

Author: codingliang

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

Description: 订单列表【管理端】

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

orderId

int64

订单id

false

keyWord

string

关键字(订单号、房间号)

false

userFlag

string

订单用户标识

false

userName

string

用户姓名

false

userPhone

string

用户手机号码

false

roomNo

string

房间编号

false

roomTypeId

int64

房型id

false

statu

string

状态 0已取消、1待支付、2待入住、3已入住、4-1退款中、4-2欠款待支付、5已完成

false

enableStartTime

string

最早入住时间最早可入住时间 yyyy-MM-dd HH:mm:ss

false

enableEndTime

string

最晚离店时间最晚要离店时间 yyyy-MM-dd HH:mm:ss

false

payTime1

string

支付时间开始 yyyy-MM-dd HH:mm:ss

false

payTime2

string

支付时间结束 yyyy-MM-dd HH:mm:ss

false

createTime1

string

创建时间开始 yyyy-MM-dd HH:mm:ss

false

createTime2

string

创建时间结束 yyyy-MM-dd HH:mm:ss

false

deleteFlag

string

删除标识 1正常，0删除

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/admin/order/page?order=x4h481&enableEndTime=2023-06-21 16:57:37&userPhone=13938323718&payTime2=2023-06-21 16:57:37&orderId=725&userFlag=8qxunu&enableStartTime=2023-06-21 16:57:37&pageSize=10&roomTypeId=853&roomNo=gybibg&userName=弘文.潘&createTime1=2023-06-21 16:57:37&createTime2=2023-06-21 16:57:37&keyWord=i90aiq&statu=p4uijw&deleteFlag=lo0t6c&orderField=gy5bvx&payTime1=2023-06-21 16:57:37&curPage=1

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─order

object

订单信息

└─id

int64

└─orderNo

string

订单编号

└─userFlag

string

订单用户标识

└─userName

string

用户姓名

└─userPhone

string

用户手机号码

└─roomId

int64

房间id

└─roomNo

string

房间编号

└─roomTypeId

int64

房型id

└─roomTypeName

string

房型名称

└─roomTypeMasterImg

string

房型主图

└─payAmount

number

实际支付金额

└─payMethod

string

支付方式（保留字段，页面暂不显示）

└─createTime

string

下单时间

└─payTime

string

支付时间

└─orderStatu

string

订单状态 0已取消、1待支付、2待入住、3已入住、4待结账、5已完成

└─bizStatu

string

业务状态 0待处理、1发起退款、2发起结账支付、3退款或结账支付完成

└─enableStartTime

string

最早入住时间最早可入住时间

└─enableEndTime

string

最晚离店时间最晚要离店时间

└─realStartTime

string

实际入住时间

└─realEndTime

string

实际离店时间

└─mayIntoTime

string

预计到店时间预计到店时间

└─remark

string

备注

└─deleteFlag

string

删除标识 0删除、1正常

└─orderBill

object

订单账单信息

└─id

int64

└─hotelOrderId

int64

订单id

└─roomId

int64

房间id

└─startOfWater

string

水起码单位：吨

└─endOfWater

string

水止码单位：吨

└─startOfElectric

string

电起码单位：度

└─endOfElectric

string

电止码单位：度

└─priceOfWater

string

水单价单位：元/吨

└─priceOfElectric

string

电单价单位：元/度

└─totalFree

number

总费用单位：元

└─discountFree

number

减免费用单位：元

└─shouldFree

number

应缴费用总费用-减免费用单位：元

└─realFree

number

补缴费用应缴费用-预缴费用

└─statu

string

状态 1待处理、2计算完成、3处理完成

└─finishTime

string

完成时间

└─remark

string

备注

└─allOfWaterAmount

number

水费总金额

└─allOfElectricPayment

number

电费总金额

└─allOfReceiveAmount

number

收预付款= 住房天数 * 住房押金（天）

└─refundPayment

number

退预付款(refundPayment)= 收预付款(allOfReceiveAmount) + 实际支付金额(payAmount) - 水费总金额(allOfWaterAmount) - 电费总金额(allOfElectricPayment)

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 873,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "order": {
          "id": 178,
          "orderNo": "65umq0",
          "userFlag": "f2i3gu",
          "userName": "弘文.潘",
          "userPhone": "13938323718",
          "roomId": 746,
          "roomNo": "ypjige",
          "roomTypeId": 180,
          "roomTypeName": "弘文.潘",
          "roomTypeMasterImg": "s4jh7e",
          "payAmount": 861,
          "payMethod": "41nqmm",
          "createTime": "2023-06-21 16:57:37",
          "payTime": "2023-06-21 16:57:37",
          "orderStatu": "i48eqr",
          "bizStatu": "wmldm2",
          "enableStartTime": "2023-06-21 16:57:37",
          "enableEndTime": "2023-06-21 16:57:37",
          "realStartTime": "2023-06-21 16:57:37",
          "realEndTime": "2023-06-21 16:57:37",
          "mayIntoTime": "2023-06-21 16:57:37",
          "remark": "oz04ae",
          "deleteFlag": "k67oxe"
        },
        "orderBill": {
          "id": 369,
          "hotelOrderId": 849,
          "roomId": 789,
          "startOfWater": "35tg03",
          "endOfWater": "knpzqj",
          "startOfElectric": "yqd9op",
          "endOfElectric": "gvv72n",
          "priceOfWater": "ybd8vu",
          "priceOfElectric": "skej21",
          "totalFree": 651,
          "discountFree": 502,
          "shouldFree": 704,
          "realFree": 327,
          "statu": "66ayd9",
          "finishTime": "2023-06-21 16:57:37",
          "remark": "kw661g"
        },
        "allOfWaterAmount": 413,
        "allOfElectricPayment": 403,
        "allOfReceiveAmount": 400,
        "refundPayment": 507
      }
    ]
  }
}

3.6. 导出订单【管理端】

URL: http://192.168.161.34:8089/ihotel/hotelOrder/admin/order/downOrder

Type: GET

Author: codingliang

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

Description: 导出订单【管理端】

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

orderId

int64

订单id

false

keyWord

string

关键字(订单号、房间号)

false

userFlag

string

订单用户标识

false

userName

string

用户姓名

false

userPhone

string

用户手机号码

false

roomNo

string

房间编号

false

roomTypeId

int64

房型id

false

statu

string

状态 0已取消、1待支付、2待入住、3已入住、4-1退款中、4-2欠款待支付、5已完成

false

enableStartTime

string

最早入住时间最早可入住时间 yyyy-MM-dd HH:mm:ss

false

enableEndTime

string

最晚离店时间最晚要离店时间 yyyy-MM-dd HH:mm:ss

false

payTime1

string

支付时间开始 yyyy-MM-dd HH:mm:ss

false

payTime2

string

支付时间结束 yyyy-MM-dd HH:mm:ss

false

createTime1

string

创建时间开始 yyyy-MM-dd HH:mm:ss

false

createTime2

string

创建时间结束 yyyy-MM-dd HH:mm:ss

false

deleteFlag

string

删除标识 1正常，0删除

false

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/hotelOrder/admin/order/downOrder?userName=弘文.潘&curPage=1&payTime2=2023-06-21 16:57:37&userFlag=tr63v3&roomTypeId=904&pageSize=10&roomNo=j06ags&enableEndTime=2023-06-21 16:57:37&createTime1=2023-06-21 16:57:37&enableStartTime=2023-06-21 16:57:37&orderField=1nkn53&order=29tqr6&createTime2=2023-06-21 16:57:37&deleteFlag=4dqtme&statu=c03fg4&payTime1=2023-06-21 16:57:37&userPhone=13938323718&orderId=311&keyWord=i0jqsy

Response-example:

Doesn't return a value.

3.7. 订单详情【用户端】

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/{orderId}

Type: GET

Author: codingliang

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

Description: 订单详情【用户端】

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X GET -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/269

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─orderNo

string

订单编号

└─userName

string

用户姓名

└─userPhone

string

用户手机号码

└─createTime

string

下单时间

└─payTime

string

支付时间

└─enableStartTime

string

最早入住时间最早可入住时间

└─enableEndTime

string

最晚离店时间最晚要离店时间

└─roomId

int64

房间id

└─roomNo

string

房间编号

└─roomTypeId

int64

房型id

└─roomTypeName

string

房型名称

└─roomTypeUsualPrice

number

房型日常价格

└─roomTypeDiscountPrice

number

房型优惠价格

└─payAmount

number

实际支付金额

└─orderStatu

string

订单状态 0已取消、1待支付、2待入住、3已入住、4待结账、5已完成

└─bizStatu

string

业务状态 0待处理、1发起退款、2发起结账支付、3退款或结账支付完成，订单状态为4的时候，显示该状态

└─startOfWater

string

水起码单位：吨

└─endOfWater

string

水止码单位：吨

└─startOfElectric

string

电起码单位：度

└─endOfElectric

string

电止码单位：度

└─totalFree

number

（水电）总费用单位：元

└─discountFree

number

（水电）减免费用单位：元

└─shouldFree

number

应缴费用总费用-减免费用单位：元

└─realFree

number

补缴费用应缴费用-预缴费用【补缴费用大于0时需要调用补缴接口发起支付】

└─lockRealtimePassword

string

锁实时密码

└─passwordStartTime

string

锁实时密码有效时间-开始

└─passwordEndTime

string

锁实时密码有效时间-结束

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "orderId": 861,
    "orderNo": "1k3klj",
    "userName": "弘文.潘",
    "userPhone": "13938323718",
    "createTime": "2023-06-21 16:57:37",
    "payTime": "2023-06-21 16:57:37",
    "enableStartTime": "2023-06-21 16:57:37",
    "enableEndTime": "2023-06-21 16:57:37",
    "roomId": 878,
    "roomNo": "4mvh47",
    "roomTypeId": 995,
    "roomTypeName": "弘文.潘",
    "roomTypeUsualPrice": 289,
    "roomTypeDiscountPrice": 125,
    "payAmount": 520,
    "orderStatu": "frd5yl",
    "bizStatu": "hlar0v",
    "startOfWater": "apjbbr",
    "endOfWater": "98r6z8",
    "startOfElectric": "e4ae6y",
    "endOfElectric": "fmg8iq",
    "totalFree": 69,
    "discountFree": 144,
    "shouldFree": 738,
    "realFree": 74,
    "lockRealtimePassword": "x62r8w",
    "passwordStartTime": "2023-06-21 16:57:37",
    "passwordEndTime": "2023-06-21 16:57:37"
  }
}

3.8. 获取订单支付参数

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/pay/{orderId}

Type: GET

Author: codingliang

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

Description: 获取订单支付参数

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X GET -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/pay/723

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─payAmount

number

实际支付金额，如果实际支付金额为0，则不需要调用支付接口，直接跳转到支付成功页面

└─payUrl

string

支付地址

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "orderId": 836,
    "payAmount": 304,
    "payUrl": "www.xn---xn--674a-9y5v.org"
  }
}

3.9. 获取订单结账信息

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/bill/{orderId}

Type: GET

Author: codingliang

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

Description: 获取订单结账信息

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X GET -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/bill/719

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─billId

int64

账单id

└─flag

string

处理标识 1待退款、2待补缴、3订单完结

└─refundFee

number

待退款金额

└─supperFee

number

待补缴金额

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "orderId": 945,
    "billId": 18,
    "flag": "h4zwsz",
    "refundFee": 23,
    "supperFee": 519
  }
}

3.10. 删除订单【用户端】

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/{orderId}

Type: DELETE

Author: codingliang

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

Description: 删除订单【用户端】

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X DELETE -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/473

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "zwed4y"
}

3.11. 删除订单【管理端】

URL: http://192.168.161.34:8089/ihotel/hotelOrder/admin/order/{orderId}

Type: DELETE

Author: codingliang

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

Description: 删除订单【管理端】

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X DELETE -H 'admin_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/admin/order/364

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "f630ek"
}

3.12. 取消订单

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/cancel/{orderId}

Type: PUT

Author: codingliang

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

Description: 取消订单

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X PUT -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/cancel/43

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "aqfc2c"
}

3.13. 办理入住

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/hold/{orderId}

Type: PUT

Author: codingliang

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

Description: 办理入住

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X PUT -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/hold/269

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "jp9q0q"
}

3.14. 办理退房

URL: http://192.168.161.34:8089/ihotel/hotelOrder/user/order/return/{orderId}

Type: PUT

Author: codingliang

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

Description: 办理退房

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X PUT -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelOrder/user/order/return/949

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─orderId

int64

订单id

└─billId

int64

账单id

└─flag

string

处理标识 1待退款、2待补缴、3订单完结

└─refundFee

number

待退款金额

└─supperFee

number

待补缴金额

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "orderId": 420,
    "billId": 884,
    "flag": "ibr1vu",
    "refundFee": 27,
    "supperFee": 609
  }
}

3.15. 生成统计报表 scheduled\SystemScheduled.java 每月1号凌晨5点自动统计上月数据

URL: http://192.168.161.34:8089/ihotel/hotelOrder/createReport

Type: GET

Author: codingliang

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

Description: 生成统计报表 scheduled\SystemScheduled.java 每月1号凌晨5点自动统计上月数据

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/hotelOrder/createReport

Response-example:

Doesn't return a value.

4. 酒店员工

4.1. 部门员工列表

URL: http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/departList

Type: GET

Author: codingliang

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

Description: 部门员工列表

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/departList

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

string

部门id

└─department

string

部门名称

└─staffs

array

员工信息

└─id

int64

└─cardNumber

string

员工卡号微校card_number

└─phone

string

手机号码登录账号

└─username

string

员工姓名

└─position

string

职位

└─departid

string

部门

└─statu

string

状态 0冻结、1正常

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": [
    {
      "id": "52",
      "department": "yobz64",
      "staffs": [
        {
          "id": 792,
          "cardNumber": "o77yql",
          "phone": "13938323718",
          "username": "弘文.潘",
          "position": "l1uxo8",
          "departid": "52",
          "statu": "mr4cdo"
        }
      ]
    }
  ]
}

4.2. 员工列表

URL: http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/list

Type: GET

Author: codingliang

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

Description: 员工列表

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter

Type

Description

Required

Since

keyword

string

关键字，支持姓名和手机号搜索

false

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/list?pageSize=10&curPage=1&order=kwx7kh&keyword=5r4wsw&orderField=piclc4

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─cardNumber

string

员工卡号微校card_number

└─phone

string

手机号码登录账号

└─username

string

员工姓名

└─position

string

职位

└─departid

string

部门

└─statu

string

状态 0冻结、1正常

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 615,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 268,
        "cardNumber": "e40k6b",
        "phone": "13938323718",
        "username": "弘文.潘",
        "position": "mabtex",
        "departid": "52",
        "statu": "dh94vb"
      }
    ]
  }
}

4.3. 员工信息

URL: http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/info/{id}

Type: GET

Author: codingliang

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

Description: 员工信息

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Path-parameters:

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/info/853

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─cardNumber

string

员工卡号微校card_number

└─phone

string

手机号码登录账号

└─username

string

员工姓名

└─position

string

职位

└─departid

string

部门

└─statu

string

状态 0冻结、1正常

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "id": 965,
    "cardNumber": "cyd9so",
    "phone": "13938323718",
    "username": "弘文.潘",
    "position": "w0ua3t",
    "departid": "52",
    "statu": "vuxrwf"
  }
}

4.4. 新增员工

URL: http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/save

Type: POST

Author: codingliang

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

Description: 新增员工

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

cardNumber

string

员工卡号微校card_number

true

phone

string

手机号码登录账号

true

username

string

员工姓名

true

position

string

职位

true

departid

string

部门

true

statu

string

状态 0冻结、1正常

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/save --data '{
  "id": 652,
  "cardNumber": "hdbv47",
  "phone": "13938323718",
  "username": "弘文.潘",
  "position": "ygvlvy",
  "departid": "52",
  "statu": "p4x9hl"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "xphchb"
}

4.5. 修改员工

URL: http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/update

Type: PUT

Author: codingliang

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

Description: 修改员工

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

false

cardNumber

string

员工卡号微校card_number

true

phone

string

手机号码登录账号

true

username

string

员工姓名

true

position

string

职位

true

departid

string

部门

true

statu

string

状态 0冻结、1正常

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/update --data '{
  "id": 184,
  "cardNumber": "e7rns2",
  "phone": "13938323718",
  "username": "弘文.潘",
  "position": "1bnal1",
  "departid": "52",
  "statu": "64g0dt"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "i4joqf"
}

4.6. 删除员工

URL: http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/delete

Type: DELETE

Author: codingliang

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

Description: 删除员工

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/ihotel/hotelStaff/delete --data '[
  732,
  911
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "j1szpu"
}

5. 普通用户

5.1. 微校授权回调地址

URL: http://192.168.161.34:8089/ihotel/hotelUser/weixiaoAuth

Type: GET

Author: codingliang

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

Description: 用户跳转到微校授权链接上，微校服务器接收用户授权后会携带wxcode回调到该接口上，该接口使用wxcode获取到用户的信息。
如果用户信息获取成功，该接口会以【fontEndUrl + /?token=】的形式跳回到前端应用页面；
如果用户信息获取失败，该接口会以【fontEndUrl + /error/?errorMsg=获取用户信息失败】的形式跳回到前端应用页面。
注意：
fontEndUrl + 路由地址：前端项目地址+页面路由地址，用于前端页面接收用户的信息或错误信息，该地址需要前端人员与后台开发人员协调好。

Query-parameters:

Parameter

Type

Description

Required

Since

wxcode

string

微校code

false

state

string

透传数据

false

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/hotelUser/weixiaoAuth?wxcode=31871&state=kaxg4l

Response-example:

string

5.2. 获取用户信息

URL: http://192.168.161.34:8089/ihotel/hotelUser/userInfo

Type: GET

Author: codingliang

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

Description: 获取用户信息

Request-headers:

Header

Type

Description

Required

Since

user_token

string

用户token

true

Request-example:

curl -X GET -H 'user_token' -i http://192.168.161.34:8089/ihotel/hotelUser/userInfo

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─cardNumber

string

卡号

└─name

string

姓名

└─telPhone

string

手机号码

└─headImage

string

头像

└─identityType

string

身份类型 0其他、1学生、4教职工、5校友

└─statu

string

状态 0拉黑、1正常

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "id": 26,
    "cardNumber": "xrg6iz",
    "name": "弘文.潘",
    "telPhone": "13938323718",
    "headImage": "cu6fl9",
    "identityType": "5jhphv",
    "statu": "3s6kd3"
  }
}

6. 文件服务

6.1. 获取上传文件签名

URL: http://192.168.161.34:8089/ihotel/oss/aliyun/policy

Type: GET

Author: codingliang

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

Description: 用于文件上传时获取上传文件签名，采用服务器签名后直传的方式进行文件上传，
具体文档参考：https://help.aliyun.com/document_detail/31926.html

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/oss/aliyun/policy

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─accessId

string

AccessKey ID

└─policy

string

用户表单上传的策略（Policy）

└─signature

string

Policy签名后的字符串

└─dir

string

文件前缀

└─host

string

上传请求的域名

└─expire

string

Policy过期时间

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "accessId": "52",
    "policy": "gax4vg",
    "signature": "mibcqw",
    "dir": "px1axv",
    "host": "mjjeay",
    "expire": "tskq2v"
  }
}

7.

7.1. 获取设备详情

URL: http://192.168.161.34:8089/ihotel/passwordIss/getDeviceInfo

Type: GET

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

Description: 获取设备详情

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Query-parameters:

Parameter

Type

Description

Required

Since

luid

string

No comments found.

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/passwordIss/getDeviceInfo?luid=7ffb8be7-039b-4089-b590-36d223b5a80e

Response-example:

Doesn't return a value.

7.2. 添加卡片

URL: http://192.168.161.34:8089/ihotel/passwordIss/addCardInfo

Type: POST

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

Description: 添加卡片

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

luid

string

锁设备ID

true

card

string

卡号

true

startTime

string

开始时间时间戳

true

endTime

string

结束时间时间戳

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/passwordIss/addCardInfo --data '{
  "luid": "7ffb8be7-039b-4089-b590-36d223b5a80e",
  "card": "ezupg8",
  "startTime": "2023-06-21 16:57:36",
  "endTime": "2023-06-21 16:57:36"
}'

Response-example:

Doesn't return a value.

7.3. 下发指纹

URL: http://192.168.161.34:8089/ihotel/passwordIss/addFingerprintData

Type: POST

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

Description: 下发指纹

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

luid

string

锁设备ID

true

fingerprintData

string

指纹特征值

true

startTime

string

开始时间时间戳

true

endTime

string

结束时间时间戳

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/passwordIss/addFingerprintData --data '{
  "luid": "7ffb8be7-039b-4089-b590-36d223b5a80e",
  "fingerprintData": "jvzfjn",
  "startTime": "2023-06-21 16:57:36",
  "endTime": "2023-06-21 16:57:36"
}'

Response-example:

Doesn't return a value.

7.4. 下发密码

URL: http://192.168.161.34:8089/ihotel/passwordIss/addPassword

Type: POST

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

Description: 下发密码

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

luid

string

锁设备ID

true

startTime

string

开始时间时间戳

true

endTime

string

结束时间时间戳

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/passwordIss/addPassword --data '{
  "luid": "7ffb8be7-039b-4089-b590-36d223b5a80e",
  "startTime": "2023-06-21 16:57:36",
  "endTime": "2023-06-21 16:57:36"
}'

Response-example:

Doesn't return a value.

8. 酒店员工

8.1. 部门员工列表

URL: http://192.168.161.34:8089/ihotel/ihotel/hotelDepartment/list

Type: GET

Author: codingliang

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

Description: 部门员工列表

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/ihotel/hotelDepartment/list

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

string

id，新增时不需要传

└─name

string

部门名称

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": [
    {
      "id": "52",
      "name": "弘文.潘"
    }
  ]
}

9. 房间

9.1. 房间列表（分页）

URL: http://192.168.161.34:8089/ihotel/room/page

Type: GET

Author: codingliang

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

Description: 房间列表（分页）

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

roomNo

string

房间号

false

build

string

所处楼栋

false

floor

string

所处楼层

false

roomTypeId

int64

房型id

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/room/page?build=vj4o1c&roomTypeId=206&orderField=jgya9j&order=kitsl8&floor=ngm9oh&roomNo=gls2h5&curPage=1&pageSize=10

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

id，新增时不需要传

└─roomNo

string

房屋号

└─build

string

所处楼栋

└─floor

string

所处楼层

└─roomTypeId

int64

房型id

└─roomTypeName

string

房型名称

└─enableUse

string

是否可用 0否，1是

└─electricType

string

电开关 1关，2开

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 825,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 331,
        "roomNo": "k15cn2",
        "build": "p11f7j",
        "floor": "1a974i",
        "roomTypeId": 816,
        "roomTypeName": "弘文.潘",
        "enableUse": "g909i1",
        "electricType": "wxu5ub"
      }
    ]
  }
}

9.2. 房间列表（分页分组）

URL: http://192.168.161.34:8089/ihotel/room/page/group

Type: GET

Author: codingliang

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

Description: 房间列表（分页分组）

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

roomNo

string

房间号

false

build

string

所处楼栋

false

floor

string

所处楼层

false

roomTypeId

int64

房型id

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/room/page/group?roomNo=34ngmj&roomTypeId=258&floor=1djfcb&orderField=7s8d5h&curPage=1&order=6uktqg&pageSize=10&build=sqxh2h

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─build

string

楼栋号

└─floors

array

楼层列表

└─floor

string

楼层

└─room

array

房间列表

└─id

int64

id，新增时不需要传

└─roomNo

string

房屋号

└─build

string

所处楼栋

└─floor

string

所处楼层

└─roomTypeId

int64

房型id

└─roomTypeName

string

房型名称

└─enableUse

string

是否可用 0否，1是

└─electricType

string

电开关 1关，2开

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 659,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "build": "4rvsyx",
        "floors": [
          {
            "floor": "hnlsnh",
            "room": [
              {
                "id": 852,
                "roomNo": "qx6wmo",
                "build": "e1xyag",
                "floor": "5ggrgj",
                "roomTypeId": 443,
                "roomTypeName": "弘文.潘",
                "enableUse": "xtk2za",
                "electricType": "i0kvi2"
              }
            ]
          }
        ]
      }
    ]
  }
}

9.3. 新增房间

URL: http://192.168.161.34:8089/ihotel/room/save

Type: POST

Author: codingliang

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

Description: 新增房间

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

id，新增时不需要传

false

roomNo

string

房屋号

true

build

string

所处楼栋

true

floor

string

所处楼层

true

roomTypeId

int64

房型id

true

roomTypeName

string

房型名称

true

enableUse

string

是否可用 0否，1是

true

electricType

string

电开关 1关，2开

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/room/save --data '{
  "id": 882,
  "roomNo": "oefefc",
  "build": "e94dch",
  "floor": "bj4ov6",
  "roomTypeId": 133,
  "roomTypeName": "弘文.潘",
  "enableUse": "kj0pdu",
  "electricType": "j34gje"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "qdhm38"
}

9.4. 修改房间

URL: http://192.168.161.34:8089/ihotel/room/update

Type: PUT

Author: codingliang

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

Description: 修改房间，房型数据不能被修改，若要修改房间房型，请先删除后新增

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

id，新增时不需要传

false

roomNo

string

房屋号

true

build

string

所处楼栋

true

floor

string

所处楼层

true

roomTypeId

int64

房型id

true

roomTypeName

string

房型名称

true

enableUse

string

是否可用 0否，1是

true

electricType

string

电开关 1关，2开

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/room/update --data '{
  "id": 170,
  "roomNo": "dzfig9",
  "build": "31vinu",
  "floor": "yptw1l",
  "roomTypeId": 804,
  "roomTypeName": "弘文.潘",
  "enableUse": "16vgp4",
  "electricType": "kujs92"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "5s8sv6"
}

9.5. 删除房间

URL: http://192.168.161.34:8089/ihotel/room/delete

Type: DELETE

Author: codingliang

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

Description: 删除房间

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/room/delete --data '[
  717,
  543
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "fi6f88"
}

10. 门锁

10.1. 根据房间id查询密码锁

URL: http://192.168.161.34:8089/ihotel/roomDoorLock/room/{roomId}

Type: GET

Author: codingliang

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

Description: 根据房间id查询密码锁

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter

Type

Description

Required

Since

roomId

int64

房间id

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomDoorLock/room/686

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

int64

└─roomId

int64

房间id

└─orderId

int64

订单id

└─lockId

string

锁id 用于删除锁

└─lockRealtimePassword

string

实时密码

└─startTime

string

有效时间-开始

└─endTime

string

有效时间-结束

└─updateTime

string

更新时间

└─lockUserId

string

锁用户ID（调用青松接口返回的id）

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": [
    {
      "id": 3,
      "roomId": 660,
      "orderId": 967,
      "lockId": "52",
      "lockRealtimePassword": "e1da9q",
      "startTime": "2023-06-21 16:57:37",
      "endTime": "2023-06-21 16:57:37",
      "updateTime": "2023-06-21 16:57:37",
      "lockUserId": "52"
    }
  ]
}

10.2. 根据订单id查询密码锁

URL: http://192.168.161.34:8089/ihotel/roomDoorLock/order/{orderId}

Type: GET

Author: codingliang

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

Description: 根据订单id查询密码锁

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter

Type

Description

Required

Since

orderId

int64

订单id

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomDoorLock/order/854

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

int64

└─roomId

int64

房间id

└─orderId

int64

订单id

└─lockId

string

锁id 用于删除锁

└─lockRealtimePassword

string

实时密码

└─startTime

string

有效时间-开始

└─endTime

string

有效时间-结束

└─updateTime

string

更新时间

└─lockUserId

string

锁用户ID（调用青松接口返回的id）

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": [
    {
      "id": 907,
      "roomId": 950,
      "orderId": 749,
      "lockId": "52",
      "lockRealtimePassword": "yxop34",
      "startTime": "2023-06-21 16:57:37",
      "endTime": "2023-06-21 16:57:37",
      "updateTime": "2023-06-21 16:57:37",
      "lockUserId": "52"
    }
  ]
}

10.3. 根据订单id下发密码锁

URL: http://192.168.161.34:8089/ihotel/roomDoorLock/sendPassword/{id}

Type: GET

Author: codingliang

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

Description: 根据订单id下发密码锁

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter

Type

Description

Required

Since

int64

门锁id

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomDoorLock/sendPassword/366

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

int64

└─roomId

int64

房间id

└─orderId

int64

订单id

└─lockId

string

锁id 用于删除锁

└─lockRealtimePassword

string

实时密码

└─startTime

string

有效时间-开始

└─endTime

string

有效时间-结束

└─updateTime

string

更新时间

└─lockUserId

string

锁用户ID（调用青松接口返回的id）

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": [
    {
      "id": 974,
      "roomId": 715,
      "orderId": 758,
      "lockId": "52",
      "lockRealtimePassword": "9f9yn3",
      "startTime": "2023-06-21 16:57:37",
      "endTime": "2023-06-21 16:57:37",
      "updateTime": "2023-06-21 16:57:37",
      "lockUserId": "52"
    }
  ]
}

11. 实时房态

11.1. 房态信息

URL: http://192.168.161.34:8089/ihotel/roomRealTimeStatu/realData

Type: GET

Author: codingliang

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

Description: 房态信息

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter

Type

Description

Required

Since

startDay

string

开始时间 yyyy-MM-dd

true

endDay

string

结束时间 yyyy-MM-dd

true

roomIds

array

房间id集合

true

statu

string

房态类型状态 1空闲、2预定、3入住、4脏房、5锁定逗号拼接1,2,3,4,5

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomRealTimeStatu/realData?startDay=2023-06-21&endDay=2023-06-21&statu=osaztv

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─roomId

int64

房间id

└─statuId

int64

房态id，房态为1时该字段不会存在

└─statu

string

当前状态 1空闲、2预定、3入住、4脏房、5锁定

└─useInfo

object

房间使用信息当前状态为2、3、4时该字段有值

└─orderId

int64

订单id

└─userName

string

客人姓名

└─enableStartTime

string

开始时间

└─enableEndTime

string

退房时间

└─startOfWater

string

水起码单位：吨

└─startOfElectric

string

电起码单位：度

└─electricType

string

电开关 1关，2开

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": [
    {
      "roomId": 335,
      "statuId": "7ffb8be7-039b-4089-b590-36d223b5a80e",
      "statu": "mhn04e",
      "useInfo": {
        "orderId": 782,
        "userName": "弘文.潘",
        "enableStartTime": "2023-06-21 16:57:37",
        "enableEndTime": "2023-06-21 16:57:37",
        "startOfWater": "r781l1",
        "startOfElectric": "qom3z3"
      },
      "electricType": "ke9s0e"
    }
  ]
}

11.2. 脏房修改为空闲房间

URL: http://192.168.161.34:8089/ihotel/roomRealTimeStatu/clean/cleanByStatuId

Type: POST

Author: codingliang

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

Description: 注意，只有当房间为脏房或被锁定时，房间状态才可以被置为空闲房间

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter

Type

Description

Required

Since

statuIds

array

No comments found.

false

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomRealTimeStatu/clean/cleanByStatuId --data '{
  "statuIds": [
    45
  ]
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "fuz95o"
}

11.3. 房间转为脏房

URL: http://192.168.161.34:8089/ihotel/roomRealTimeStatu/toDirty

Type: PUT

Author: codingliang

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

Description: 房间转为脏房

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter

Type

Description

Required

Since

roomId

int64

房间id

true

startDay

string

状态开始时间

true

endDay

string

状态结束时间

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomRealTimeStatu/toDirty --data '{
  "roomId": 799,
  "startDay": "2023-06-21",
  "endDay": "2023-06-21"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "ecnrwd"
}

11.4. 锁定房间

URL: http://192.168.161.34:8089/ihotel/roomRealTimeStatu/lock

Type: PUT

Author: codingliang

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

Description: 锁定房间

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter

Type

Description

Required

Since

roomId

array

房间id

true

startDate

string

锁定开始时间 yyyy-MM-dd

true

endDate

string

锁定结束时间 yyyy-MM-dd

true

remark

string

备注

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomRealTimeStatu/lock --data '{
  "roomId": [
    536
  ],
  "startDate": "2023-06-21",
  "endDate": "2023-06-21",
  "remark": "k9w5ac"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "m66nv9"
}

12. 房间第三方平台设置

12.1. 新增房间第三方平台设置

URL: http://192.168.161.34:8089/ihotel/roomThirdSetting/add

Type: POST

Author: codingliang

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

Description: 新增房间第三方平台设置

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

id，新增时不需要传

false

roomId

int64

房间id

false

waterId

string

水表码

true

electricId

string

电表码

true

lockId

string

UID锁id

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomThirdSetting/add --data '{
  "id": 466,
  "roomId": 502,
  "waterId": "52",
  "electricId": "52",
  "lockId": "52"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "qcu0bk"
}

12.2. 修改房间第三方平台设置

URL: http://192.168.161.34:8089/ihotel/roomThirdSetting/update

Type: POST

Author: codingliang

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

Description: 修改房间第三方平台设置

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

id，新增时不需要传

false

roomId

int64

房间id

false

waterId

string

水表码

true

electricId

string

电表码

true

lockId

string

UID锁id

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomThirdSetting/update --data '{
  "id": 261,
  "roomId": 710,
  "waterId": "52",
  "electricId": "52",
  "lockId": "52"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "uxq4zw"
}

12.3. 根据房间id查询

URL: http://192.168.161.34:8089/ihotel/roomThirdSetting/setting/{roomId}

Type: GET

Author: codingliang

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

Description: 根据房间id查询

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter

Type

Description

Required

Since

roomId

int64

房间id

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomThirdSetting/setting/129

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

id，新增时不需要传

└─roomId

int64

房间id

└─waterId

string

水表码

└─electricId

string

电表码

└─lockId

string

UID锁id

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "id": 577,
    "roomId": 316,
    "waterId": "52",
    "electricId": "52",
    "lockId": "52"
  }
}

12.4. 电控制

URL: http://192.168.161.34:8089/ihotel/roomThirdSetting/changeElectric/{roomId}/{operType}

Type: GET

Author: codingliang

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

Description: 电控制

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Path-parameters:

Parameter

Type

Description

Required

Since

roomId

int64

房间id

true

operType

string

操作类型 1关电、2开电

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomThirdSetting/changeElectric/798/sfdnzm

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─operType

string

电控操作类型 1关电 2开电

└─resultType

string

电控操作后电状态

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "operType": "f6241k",
    "resultType": "scww70"
  }
}

13. 房型

13.1. 房型列表（客户端）

URL: http://192.168.161.34:8089/ihotel/roomType/list

Type: GET

Author: codingliang

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

Description: 房型列表（客户端）

Query-parameters:

Parameter

Type

Description

Required

Since

startDate

string

入住时间 yyyy-MM-dd

true

endDate

string

离店时间 yyyy-MM-dd

true

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/roomType/list?endDate=2023-06-21&startDate=2023-06-21

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

array

接口调用返回数据

└─id

int64

房型id

└─typeName

string

房型名称

└─usualPrice

number

日常价格单位：元/间/晚

└─discountPrice

number

优惠价格单位：元/间/晚

└─typeShortDesc

string

房型简单描述

└─enableNum

int32

房间剩余数量

└─masterImage

string

房型图

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": [
    {
      "id": 889,
      "typeName": "弘文.潘",
      "usualPrice": 910,
      "discountPrice": 257,
      "typeShortDesc": "r04xq5",
      "enableNum": 673,
      "masterImage": "nbk8ax"
    }
  ]
}

13.2. 房型列表（管理端）

URL: http://192.168.161.34:8089/ihotel/roomType/page

Type: GET

Author: codingliang

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

Description: 房型列表（管理端）

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomType/page?pageSize=10&curPage=1&orderField=pz7mfv&order=1gcfwv

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

id，新增时不用传

└─typeName

string

房型名称

└─usualPrice

number

日常价格单位：元/间/晚

└─discountPrice

number

优惠价格单位：元/间/晚

└─typeShortDesc

string

房型简单描述

└─typeDesc

string

房型详细描述

└─roomNum

int32

房间数量

└─typeImage

string

房型图，使用阿里云上传获取图片链接第一张为主图，多张图片之间使用,分割

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 350,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 447,
        "typeName": "弘文.潘",
        "usualPrice": 17,
        "discountPrice": 253,
        "typeShortDesc": "eaqo99",
        "typeDesc": "oox973",
        "roomNum": 62,
        "typeImage": "qli37t"
      }
    ]
  }
}

13.3. 房型详细信息

URL: http://192.168.161.34:8089/ihotel/roomType/info/{id}

Type: GET

Author: codingliang

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

Description: 房型详细信息

Path-parameters:

Parameter

Type

Description

Required

Since

int64

No comments found.

true

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/roomType/info/49

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

id，新增时不用传

└─typeName

string

房型名称

└─usualPrice

number

日常价格单位：元/间/晚

└─discountPrice

number

优惠价格单位：元/间/晚

└─typeShortDesc

string

房型简单描述

└─typeDesc

string

房型详细描述

└─roomNum

int32

房间数量

└─typeImage

string

房型图，使用阿里云上传获取图片链接第一张为主图，多张图片之间使用,分割

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "id": 957,
    "typeName": "弘文.潘",
    "usualPrice": 633,
    "discountPrice": 706,
    "typeShortDesc": "rgkewf",
    "typeDesc": "trcy69",
    "roomNum": 514,
    "typeImage": "owlfp1"
  }
}

13.4. 新增房型

URL: http://192.168.161.34:8089/ihotel/roomType/save

Type: POST

Author: codingliang

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

Description: 新增房型

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

id，新增时不用传

false

typeName

string

房型名称

true

usualPrice

number

日常价格单位：元/间/晚

true

discountPrice

number

优惠价格单位：元/间/晚

true

typeShortDesc

string

房型简单描述

true

typeDesc

string

房型详细描述

true

roomNum

int32

房间数量

true

typeImage

string

房型图，使用阿里云上传获取图片链接第一张为主图，多张图片之间使用,分割

true

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomType/save --data '{
  "id": 610,
  "typeName": "弘文.潘",
  "usualPrice": 376,
  "discountPrice": 219,
  "typeShortDesc": "h8h3ry",
  "typeDesc": "yf8qkv",
  "roomNum": 841,
  "typeImage": "cw99tn"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "lolh0u"
}

13.5. 修改房型

URL: http://192.168.161.34:8089/ihotel/roomType/update

Type: PUT

Author: codingliang

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

Description: 修改房型

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

id，新增时不用传

false

typeName

string

房型名称

true

usualPrice

number

日常价格单位：元/间/晚

true

discountPrice

number

优惠价格单位：元/间/晚

true

typeShortDesc

string

房型简单描述

true

typeDesc

string

房型详细描述

true

roomNum

int32

房间数量

true

typeImage

string

房型图，使用阿里云上传获取图片链接第一张为主图，多张图片之间使用,分割

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomType/update --data '{
  "id": 488,
  "typeName": "弘文.潘",
  "usualPrice": 599,
  "discountPrice": 24,
  "typeShortDesc": "4i8dq6",
  "typeDesc": "1vx967",
  "roomNum": 933,
  "typeImage": "4swvzk"
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "jof9r7"
}

13.6. 删除房型

URL: http://192.168.161.34:8089/ihotel/roomType/delete

Type: DELETE

Author: codingliang

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

Description: 删除房型

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

No comments found.,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/roomType/delete --data '[
  806,
  324
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "zjvqxe"
}

14. 统计报表

14.1. 查询统计报表数据【管理端】

URL: http://192.168.161.34:8089/ihotel/report/queryReport

Type: GET

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

Description: 查询统计报表数据【管理端】

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token令牌

true

Query-parameters:

Parameter

Type

Description

Required

Since

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

startTime

string

起始时间 yyyy-MM

false

endTime

string

终止时间 yyyy-MM

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/report/queryReport?startTime=2023-06-21 16:57:36&curPage=1&pageSize=10&order=pbsaba&orderField=mq5uul&endTime=2023-06-21 16:57:36

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

14.2. 导出报表【管理端】

URL: http://192.168.161.34:8089/ihotel/report/downLoadReport

Type: GET

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

Description: 导出报表【管理端】

Query-parameters:

Parameter

Type

Description

Required

Since

startTime

string

起始时间 yyyy-MM

false

endTime

string

终止时间 yyyy-MM

false

Request-example:

curl -X GET -i http://192.168.161.34:8089/ihotel/report/downLoadReport?startTime=2023-06-21 16:57:36&endTime=2023-06-21 16:57:36

Response-example:

Doesn't return a value.

15. 系统通知

15.1. 通知列表

URL: http://192.168.161.34:8089/ihotel/systemNotice/list

Type: GET

Author: codingliang

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

Description: 通知列表

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Query-parameters:

Parameter

Type

Description

Required

Since

readFlag

string

已读标识 0未读、1已读

false

curPage

int32

当前页，默认1

false

pageSize

int32

每页大小，默认10

false

orderField

string

排序字段，可选择值参考返回结果

false

order

string

排序方式，可选值：asc、desc

false

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/systemNotice/list?order=8u8lmz&orderField=jnf5jw&readFlag=9a6rmg&curPage=1&pageSize=10

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─totalCount

int32

总记录数

└─pageSize

int32

每页记录数

└─totalPage

int32

总页数

└─currPage

int32

当前页数

└─list

array

列表数据

└─id

int64

└─title

string

标题

└─content

string

内容

└─type

string

类型

└─createTime

string

发生时间

└─readFlag

string

是否已读 0未读、1已读

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "totalCount": 964,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 843,
        "title": "sr85a8",
        "content": "3xmjg4",
        "type": "sxdmlx",
        "createTime": "2023-06-21 16:57:37",
        "readFlag": "sd8dg0"
      }
    ]
  }
}

15.2. 标记为已读

URL: http://192.168.161.34:8089/ihotel/systemNotice/read

Type: PUT

Author: codingliang

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

Description: 标记为已读

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

消息id集合,[array of int64]

false

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/systemNotice/read --data '[
  255,
  107
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "pw3fi6"
}

15.3. 删除通知

URL: http://192.168.161.34:8089/ihotel/systemNotice/delete

Type: DELETE

Author: codingliang

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

Description: 删除通知

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Body-parameters:

Parameter

Type

Description

Required

Since

ids

array

消息id集合,[array of int64]

false

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/systemNotice/delete --data '[
  666,
  276
]'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "uzu754"
}

16. 系统设置

16.1. 获取系统设置

URL: http://192.168.161.34:8089/ihotel/systemSetting/info

Type: GET

Author: codingliang

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

Description: 获取系统设置

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

管理员token

true

Request-example:

curl -X GET -H 'admin_token' -i http://192.168.161.34:8089/ihotel/systemSetting/info

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

└─id

int64

└─deposit

number

押金单位：元

└─preDay

int32

预定提前天数单位：天

└─priceOfWater

number

水费单位：元/吨

└─priceOfElectric

number

电费单位：元/度

└─freeQuotaOfWater

number

水免费额度单位：吨

└─freeQuotaOfElectric

number

电免费额度单位：度

└─freeTotal

number

水电免费额度总金额单位：元

└─turnOffTime

int32

退房后断水断电时间单位：分钟

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": {
    "id": 259,
    "deposit": 617,
    "preDay": 115,
    "priceOfWater": 311,
    "priceOfElectric": 713,
    "freeQuotaOfWater": 814,
    "freeQuotaOfElectric": 762,
    "freeTotal": 875,
    "turnOffTime": 17
  }
}

16.2. 修改系统设置

URL: http://192.168.161.34:8089/ihotel/systemSetting/update

Type: PUT

Author: codingliang

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

Description: 修改系统设置

Request-headers:

Header

Type

Description

Required

Since

admin_token

string

null

true

Body-parameters:

Parameter

Type

Description

Required

Since

int64

true

deposit

number

押金单位：元

true

preDay

int32

预定提前天数单位：天

true

priceOfWater

number

水费单位：元/吨

true

priceOfElectric

number

电费单位：元/度

true

freeQuotaOfWater

number

水免费额度单位：吨

true

freeQuotaOfElectric

number

电免费额度单位：度

true

freeTotal

number

水电免费额度总金额单位：元

true

turnOffTime

int32

退房后断水断电时间单位：分钟

true

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://192.168.161.34:8089/ihotel/systemSetting/update --data '{
  "id": 300,
  "deposit": 411,
  "preDay": 106,
  "priceOfWater": 203,
  "priceOfElectric": 878,
  "freeQuotaOfWater": 874,
  "freeQuotaOfElectric": 725,
  "freeTotal": 935,
  "turnOffTime": 433
}'

Response-fields:

Field

Type

Description

Since

success

boolean

接口调用结果标识

message

string

接口调用结果信息

code

string

接口调用业务码

data

object

接口调用返回数据

Response-example:

{
  "success": true,
  "message": "success",
  "code": "31871",
  "data": "d85jlh"
}

17. 错误码列表

Error code	Description
10000	系统未知异常
10001	请求方法不支持
10002	缺少必要的请求头
10003	无效的token
10004	token为空
10005	管理员登录失败
10006	权限不足
11001	参数格式校验失败
11002	body为空
11003	参数异常
11004	重复提交表单
11005	订单提交失败
11006	消费者消费异常
11007	第三方服务调用失败
11008	农商行订单状态查询失败
16000	数据已存在
16000	数据不存在
16006	临时文件不存在
16007	文件上传失败
16008	文件太大
16009	只能关闭当天房间