lwc-cloud-erp-energy API 接口文档

服务地址

地址	说明
https://api.leadwaycloud.com/lwc-cloud-erp-energy	ERP 能源-石油服务接口

接口详情

POST

/api/oil/fuel-server/add

Fuel服务管理接口添加Fuel服务配置接口 OperationId: addUsingPOST_3

调用方法

POST /api/oil/fuel-server/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddOilFuelServerConfigDTO AddOilFuelServerConfigDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
host	string	是	网络地址	"192.168.1.134"
serverPath	string	是	服务地址	"ws://192.168.1.134:8080/fuel-server"

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«石油-Fuel服务配置» 系统返回数据模版«石油-Fuel服务配置»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	石油-Fuel服务配置	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/fuel-server/query/{id}

Fuel服务管理接口查询Fuel服务配置(ID)接口 OperationId: queryUsingGET_6

调用方法

GET /api/oil/fuel-server/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«石油-Fuel服务配置» 系统返回数据模版«石油-Fuel服务配置»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	石油-Fuel服务配置	否	返回数据

状态码: 500 说明: Fail!

无

PUT

/api/oil/fuel-server/update/{id}

Fuel服务管理接口修改Fuel服务配置接口 OperationId: addUsingPUT_4

调用方法

PUT /api/oil/fuel-server/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		Fuel服务配置ID

请求体

Content-Type: application/json 必填: 是 类型: UpdateOilFuelServerConfigDTO UpdateOilFuelServerConfigDTO

名称	类型	必填	说明	示例
host	string	否	网络地址	"192.168.1.134"
serverPath	string	否	服务地址	"ws://192.168.1.134:8080/fuel-server"

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«石油-Fuel服务配置» 系统返回数据模版«石油-Fuel服务配置»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	石油-Fuel服务配置	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/nozzle/add

油枪管理接口添加油枪接口 OperationId: addUsingPOST_2

调用方法

POST /api/oil/nozzle/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddOilNozzleDTO AddOilNozzleDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
code	string	是	枪编号	1
name	string	是	枪名称	"#1号枪"
pumpId	integer(int64)	是	泵ID	1
tankId	integer(int64)	是	罐ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«枪» 系统返回数据模版«枪»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/nozzle/query/list/{companyId}

油枪管理接口查询油枪(列表)接口 OperationId: queryListUsingGET_2

调用方法

GET /api/oil/nozzle/query/list/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是		公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«List«枪»» 系统返回数据模版«List«枪»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪[]	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/nozzle/query/{companyId}/{code}

油枪管理接口查询油枪(编号)接口 OperationId: queryUsingGET_4

调用方法

GET /api/oil/nozzle/query/{companyId}/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是		油枪编号
companyId	path	是		公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«枪» 系统返回数据模版«枪»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/nozzle/query/{id}

油枪管理接口查询油枪(ID)接口 OperationId: queryUsingGET_5

调用方法

GET /api/oil/nozzle/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«枪» 系统返回数据模版«枪»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪	否	返回数据

状态码: 500 说明: Fail!

无

PUT

/api/oil/nozzle/update/group

油枪管理接口变更油枪分组接口 OperationId: addUsingPUT_2

调用方法

PUT /api/oil/nozzle/update/group

参数

名称	位置	必填	类型	说明	示例
id	path	是		油枪ID

请求体

Content-Type: application/json 必填: 是 类型: integer(int64)[]

名称	类型	必填	说明	示例
(array)	integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«List«枪»» 系统返回数据模版«List«枪»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪[]	否	返回数据

状态码: 500 说明: Fail!

无

PUT

/api/oil/nozzle/update/{id}

油枪管理接口修改油枪接口 OperationId: addUsingPUT_3

调用方法

PUT /api/oil/nozzle/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油枪ID

请求体

Content-Type: application/json 必填: 是 类型: UpdateOilNozzleDTO UpdateOilNozzleDTO

名称	类型	必填	说明	示例
code	string	否	油枪编号	1
name	string	否	油枪名称	"#1号油枪"
pumpId	integer(int64)	否	罐ID	1
tankId	integer(int64)	否	罐ID	1

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«枪» 系统返回数据模版«枪»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/pump/add

油泵管理接口添加油泵接口 OperationId: addUsingPOST_1

调用方法

POST /api/oil/pump/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddOilPumpDTO AddOilPumpDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
code	string	是	油枪编号	1
name	string	是	油枪名称	"#1号油泵"
tankId	integer(int64)	否	默认油罐ID	1
linkTanks	integer(int64)[]	否	可连接的罐

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«泵» 系统返回数据模版«泵»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	泵	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/pump/query/list/{companyId}

油泵管理接口查询油泵(列表)接口 OperationId: queryListUsingGET_1

调用方法

GET /api/oil/pump/query/list/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是		公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«List«泵»» 系统返回数据模版«List«泵»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	泵[]	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/pump/query/{companyId}/{code}

油泵管理接口查询油泵(编号)接口 OperationId: queryUsingGET_2

调用方法

GET /api/oil/pump/query/{companyId}/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是		油泵编号
companyId	path	是		公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«泵» 系统返回数据模版«泵»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	泵	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/pump/query/{id}

油泵管理接口查询油泵(ID)接口 OperationId: queryUsingGET_3

调用方法

GET /api/oil/pump/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«泵» 系统返回数据模版«泵»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	泵	否	返回数据

状态码: 500 说明: Fail!

无

PUT

/api/oil/pump/update/{id}

油泵管理接口修改油泵接口 OperationId: addUsingPUT_1

调用方法

PUT /api/oil/pump/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油泵ID

请求体

Content-Type: application/json 必填: 是 类型: UpdateOilPumpDTO UpdateOilPumpDTO

名称	类型	必填	说明	示例
code	string	否	油枪编号	1
name	string	否	油枪名称	"#1号油泵"
tankId	integer(int64)	否	油罐ID	1
linkTanks	integer(int64)[]	否	可连接的罐

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«泵» 系统返回数据模版«泵»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	泵	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/shift-business/end-shift

班次业务管理接口交班接口 OperationId: endShiftUsingPOST

调用方法

POST /api/oil/shift-business/end-shift

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OilShiftDTO OilShiftDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
shiftNo	integer(int32)	是	班次号	1
shiftDate	string(date)	是	班次日	"2020-10-11"
tankNumberList	TankNumberDTO[]	否	油罐读数信息
pumpNumberList	PumpNumberDTO[]	否	油泵读数信息

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«boolean» 系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/shift-business/oil-back

班次业务管理接口回罐接口 OperationId: oilBackUsingPOST

调用方法

POST /api/oil/shift-business/oil-back

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OilBackDTO OilBackDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
shiftNo	integer(int32)	是	班次号	1
shiftDate	string(date)	是	班次日	"2020-10-11"
tank	string	是	油罐号	1
number	number(double)	是	读数	100
reason	string	是	理由

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«boolean» 系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/shift-business/oil-collection

班次业务管理接口收油接口 OperationId: oilCollectionUsingPOST

调用方法

POST /api/oil/shift-business/oil-collection

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OilCollectionDTO OilCollectionDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
shiftNo	integer(int32)	是	班次号	1
shiftDate	string(date)	是	班次日	"2020-10-11"
tank	string	是	油罐号	1
startTime	string(date-time)	否	开始时间	"2020-10-11 13:09:11"
endTime	string(date-time)	否	结束时间	"2020-10-11 13:09:11"
startVolume	number(double)	否	收油前体积	0
endVolume	number(double)	否	收油后体积	0
saleVolume	number(double)	否	销售体积	0
inVolume	number(double)	否	收油体积	0
v20Volume	number(double)	否	v20体积	0
p20Density	number(double)	否	p20密度	0
temperature	number(double)	否	温度	20
observedDensity	number(double)	否	密度	840.1
observedVolume	number(double)	否	油水体积	0
fuelLevel	number(double)	否	油高度	0
fuelVolume	number(double)	否	油体积	0
waterLevel	number(double)	否	水高度	0
waterVolume	number(double)	否	水体积	0
ullage	number(double)	否	损耗	0

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«boolean» 系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/shift-business/query-order

班次业务管理接口查询订单接口 OperationId: endShiftUsingPOST_1

调用方法

POST /api/oil/shift-business/query-order

参数

名称	位置	必填	说明
companyId	query	是	公司ID
endTime	query	否	截止时间
nozzle	query	否	油枪
page	query	是	查询页码
posId	query	否	机台ID
pump	query	否	油泵
size	query	是	查询页行数
startTime	query	否	开始时间
tank	query	否	油罐
tradeCode	query	否	交易号

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«系统返回分页数据模版«订单油品»» 系统返回数据模版«系统返回分页数据模版«订单油品»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	系统返回分页数据模版«订单油品»	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/shift-business/start-shift

班次业务管理接口接班接口 OperationId: startShiftUsingPOST

调用方法

POST /api/oil/shift-business/start-shift

参数

无

请求体

Content-Type: application/json 必填: 是 类型: OilShiftDTO OilShiftDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
shiftNo	integer(int32)	是	班次号	1
shiftDate	string(date)	是	班次日	"2020-10-11"
tankNumberList	TankNumberDTO[]	否	油罐读数信息
pumpNumberList	PumpNumberDTO[]	否	油泵读数信息

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«boolean» 系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/tank/add

油罐管理接口添加油罐接口 OperationId: addUsingPOST

调用方法

POST /api/oil/tank/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AddOilTankDTO AddOilTankDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	油罐编号	1
name	string	是	油罐名称	"#1号油罐"
maxVolume	number(double)	否	最大体积
alarmVolume	number(double)	否	警戒体积

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«罐» 系统返回数据模版«罐»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/tank/add/standard-info/{id}

油罐管理接口添加添加油罐规格信息接口 OperationId: addTankStandardInfoUsingPOST

调用方法

POST /api/oil/tank/add/standard-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油罐ID

请求体

Content-Type: application/json 必填: 是 类型: AddEnergyOilTankStandardInfoDTO[] AddEnergyOilTankStandardInfoDTO

名称	类型	必填	说明	示例
(array)	AddEnergyOilTankStandardInfoDTO[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«List«罐-规格信息»» 系统返回数据模版«List«罐-规格信息»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐-规格信息[]	否	返回数据

状态码: 500 说明: Fail!

无

DELETE

/api/oil/tank/delete/standard-info/{id}

油罐管理接口删除油罐规格信息接口 OperationId: deleteTankStandardInfoUsingDELETE

物理删除

调用方法

DELETE /api/oil/tank/delete/standard-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油罐规格信息ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«boolean» 系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

状态码: 500 说明: Fail!

无

POST

/api/oil/tank/export/import-standard-info-template

油罐管理接口下载油罐规格信息导入模版接口 OperationId: exportImportTankStandardInfoTemplateUsingPOST

调用方法

POST /api/oil/tank/export/import-standard-info-template

参数

无

请求体

无

响应

状态码: 200 说明: OK Content-Type: application/octet-stream 类型: string(byte)

无

状态码: 500 说明: Fail!

无

POST

/api/oil/tank/import/standard-info/{id}

油罐管理接口导入油罐规格信息接口 OperationId: importTankStandardInfoUsingPOST

调用方法

POST /api/oil/tank/import/standard-info/{id}

参数

名称	位置	必填	类型	说明	示例
file	formData	是		file
id	path	是		油罐ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«boolean» 系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/tank/query-page/standard-info/{id}

油罐管理接口查询油罐规格信息(分页)接口 OperationId: pageQueryTankStandardInfoUsingGET

调用方法

GET /api/oil/tank/query-page/standard-info/{id}

参数

名称	位置	必填	说明
id	path	是	油罐ID
page	query	是	查询页码
size	query	是	查询页行数

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«系统返回分页数据模版«罐-规格信息»» 系统返回数据模版«系统返回分页数据模版«罐-规格信息»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	系统返回分页数据模版«罐-规格信息»	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/tank/query/list/{companyId}

油罐管理接口查询油罐(列表)接口 OperationId: queryListUsingGET

调用方法

GET /api/oil/tank/query/list/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是		公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«List«罐»» 系统返回数据模版«List«罐»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐[]	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/tank/query/standard-info/{id}

油罐管理接口查询油罐规格信息(分页)接口 OperationId: queryTankStandardInfoUsingGET

调用方法

GET /api/oil/tank/query/standard-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油罐规格信息ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«罐-规格信息» 系统返回数据模版«罐-规格信息»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐-规格信息	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/tank/query/{companyId}/{code}

油罐管理接口查询油罐(编号)接口 OperationId: queryUsingGET

调用方法

GET /api/oil/tank/query/{companyId}/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是		油罐编号
companyId	path	是		公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«罐» 系统返回数据模版«罐»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐	否	返回数据

状态码: 500 说明: Fail!

无

GET

/api/oil/tank/query/{id}

油罐管理接口查询油罐(ID)接口 OperationId: queryUsingGET_1

调用方法

GET /api/oil/tank/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«罐» 系统返回数据模版«罐»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐	否	返回数据

状态码: 500 说明: Fail!

无

DELETE

/api/oil/tank/remove/standard-info/{id}

油罐管理接口清除油罐规格信息接口 OperationId: clearTankStandardInfoUsingDELETE

物理删除

调用方法

DELETE /api/oil/tank/remove/standard-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油罐ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«boolean» 系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

状态码: 500 说明: Fail!

无

PUT

/api/oil/tank/update/standard-info/{id}

油罐管理接口修改油罐规格信息接口 OperationId: updateTankStandardInfoUsingPUT

调用方法

PUT /api/oil/tank/update/standard-info/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油罐规格信息ID

请求体

Content-Type: application/json 必填: 是 类型: UpdateEnergyOilTankStandardInfoDTO UpdateEnergyOilTankStandardInfoDTO

名称	类型	必填	说明	示例
height	number(double)	否	油罐高度	1
volume	number(double)	否	油罐体积
seq	integer(int32)	否	排序

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«罐-规格信息» 系统返回数据模版«罐-规格信息»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐-规格信息	否	返回数据

状态码: 500 说明: Fail!

无

PUT

/api/oil/tank/update/{id}

油罐管理接口修改油罐接口 OperationId: addUsingPUT

调用方法

PUT /api/oil/tank/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是		油罐ID

请求体

Content-Type: application/json 必填: 是 类型: UpdateOilTankDTO UpdateOilTankDTO

名称	类型	必填	说明	示例
code	string	否	油罐编号	1
name	string	否	油罐名称	"#1号油罐"
maxVolume	number(double)	否	最大体积
alarmVolume	number(double)	否	警戒体积

响应

状态码: 200 说明: OK Content-Type: */* 类型: 系统返回数据模版«罐» 系统返回数据模版«罐»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐	否	返回数据

状态码: 500 说明: Fail!

无

模型定义

AddEnergyOilTankStandardInfoDTO

名称	类型	必填	说明	示例
height	number(double)	是	油罐高度	1
volume	number(double)	是	油罐体积
seq	integer(int32)	否	排序

AddOilFuelServerConfigDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
host	string	是	网络地址	"192.168.1.134"
serverPath	string	是	服务地址	"ws://192.168.1.134:8080/fuel-server"

AddOilNozzleDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
code	string	是	枪编号	1
name	string	是	枪名称	"#1号枪"
pumpId	integer(int64)	是	泵ID	1
tankId	integer(int64)	是	罐ID	1

AddOilPumpDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
code	string	是	油枪编号	1
name	string	是	油枪名称	"#1号油泵"
tankId	integer(int64)	否	默认油罐ID	1
linkTanks	integer(int64)[]	否	可连接的罐

AddOilTankDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	油罐编号	1
name	string	是	油罐名称	"#1号油罐"
maxVolume	number(double)	否	最大体积
alarmVolume	number(double)	否	警戒体积

OilBackDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
shiftNo	integer(int32)	是	班次号	1
shiftDate	string(date)	是	班次日	"2020-10-11"
tank	string	是	油罐号	1
number	number(double)	是	读数	100
reason	string	是	理由

OilCollectionDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
shiftNo	integer(int32)	是	班次号	1
shiftDate	string(date)	是	班次日	"2020-10-11"
tank	string	是	油罐号	1
startTime	string(date-time)	否	开始时间	"2020-10-11 13:09:11"
endTime	string(date-time)	否	结束时间	"2020-10-11 13:09:11"
startVolume	number(double)	否	收油前体积	0
endVolume	number(double)	否	收油后体积	0
saleVolume	number(double)	否	销售体积	0
inVolume	number(double)	否	收油体积	0
v20Volume	number(double)	否	v20体积	0
p20Density	number(double)	否	p20密度	0
temperature	number(double)	否	温度	20
observedDensity	number(double)	否	密度	840.1
observedVolume	number(double)	否	油水体积	0
fuelLevel	number(double)	否	油高度	0
fuelVolume	number(double)	否	油体积	0
waterLevel	number(double)	否	水高度	0
waterVolume	number(double)	否	水体积	0
ullage	number(double)	否	损耗	0

OilShiftDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	是	机台ID	1
shiftNo	integer(int32)	是	班次号	1
shiftDate	string(date)	是	班次日	"2020-10-11"
tankNumberList	TankNumberDTO[]	否	油罐读数信息
pumpNumberList	PumpNumberDTO[]	否	油泵读数信息

PumpNumberDTO

名称	类型	必填	说明	示例
pump	string	是	油泵号	1
number	number(double)	是	读数	100

TankNumberDTO

名称	类型	必填	说明	示例
tank	string	是	油罐	1
v20Volume	number(double)	否	v20体积	0
p20Density	number(double)	否	p20密度	0
temperature	number(double)	否	温度	20
observedDensity	number(double)	否	密度	840.1
observedVolume	number(double)	否	油水体积	0
fuelLevel	number(double)	否	油高度	0
fuelVolume	number(double)	否	油体积	0
waterLevel	number(double)	否	水高度	0
waterVolume	number(double)	否	水体积	0

UpdateEnergyOilTankStandardInfoDTO

名称	类型	必填	说明	示例
height	number(double)	否	油罐高度	1
volume	number(double)	否	油罐体积
seq	integer(int32)	否	排序

UpdateOilFuelServerConfigDTO

名称	类型	必填	说明	示例
host	string	否	网络地址	"192.168.1.134"
serverPath	string	否	服务地址	"ws://192.168.1.134:8080/fuel-server"

UpdateOilNozzleDTO

名称	类型	必填	说明	示例
code	string	否	油枪编号	1
name	string	否	油枪名称	"#1号油枪"
pumpId	integer(int64)	否	罐ID	1
tankId	integer(int64)	否	罐ID	1

UpdateOilPumpDTO

名称	类型	必填	说明	示例
code	string	否	油枪编号	1
name	string	否	油枪名称	"#1号油泵"
tankId	integer(int64)	否	油罐ID	1
linkTanks	integer(int64)[]	否	可连接的罐

UpdateOilTankDTO

名称	类型	必填	说明	示例
code	string	否	油罐编号	1
name	string	否	油罐名称	"#1号油罐"
maxVolume	number(double)	否	最大体积
alarmVolume	number(double)	否	警戒体积

枪

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	枪编号	1
name	string	是	枪名称	"#1号枪"
oilPump	泵	是	泵
oilTank	罐	是	罐
group	string	是	分组	"UUID"
createBy	integer(int64)	否	创建人ID	1
createTime	string(date-time)	否	创建时间	"2020-10-11 13:09:11"
updateBy	integer(int64)	否	修改人ID	1
updateTime	string(date-time)	否	修改时间	"2020-10-11 13:09:11"

泵

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	泵编号	1
name	string	是	泵名称	"#1号泵"
oilTank	罐	否	默认罐
linkTankList	罐[]	否	可连接的罐
createBy	integer(int64)	否	创建人ID	1
createTime	string(date-time)	否	创建时间	"2020-10-11 13:09:11"
updateBy	integer(int64)	否	修改人ID	1
updateTime	string(date-time)	否	修改时间	"2020-10-11 13:09:11"

石油-Fuel服务配置

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
companyId	integer(int64)	是	公司ID	1
host	string	是	网络地址	"192.168.1.134"
serverPath	string	是	服务地址	"ws://192.168.1.134:8080/fuel-server"
createBy	integer(int64)	否	创建人ID	1
createTime	string(date-time)	否	创建时间	"2020-10-11 13:09:11"
updateBy	integer(int64)	否	修改人ID	1
updateTime	string(date-time)	否	修改时间	"2020-10-11 13:09:11"

系统返回分页数据模版«罐-规格信息»

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	罐-规格信息[]	是	当前页数据

系统返回分页数据模版«订单油品»

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	订单油品[]	是	当前页数据

系统返回数据模版«List«枪»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪[]	否	返回数据

系统返回数据模版«List«泵»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	泵[]	否	返回数据

系统返回数据模版«List«罐-规格信息»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐-规格信息[]	否	返回数据

系统返回数据模版«List«罐»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐[]	否	返回数据

系统返回数据模版«boolean»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	boolean	否	返回数据

系统返回数据模版«枪»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	枪	否	返回数据

系统返回数据模版«泵»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	泵	否	返回数据

系统返回数据模版«石油-Fuel服务配置»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	石油-Fuel服务配置	否	返回数据

系统返回数据模版«系统返回分页数据模版«罐-规格信息»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	系统返回分页数据模版«罐-规格信息»	否	返回数据

系统返回数据模版«系统返回分页数据模版«订单油品»»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	系统返回分页数据模版«订单油品»	否	返回数据

系统返回数据模版«罐-规格信息»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐-规格信息	否	返回数据

系统返回数据模版«罐»

名称	类型	必填	说明	示例
status	integer(int32)	是	状态 (200:Successful!; 500:Fail!)	200
code	string	是	消息代码	"000"
message	string	是	消息	"成功"
data	罐	否	返回数据

罐

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
companyId	integer(int64)	是	公司ID	1
code	string	是	罐编号	1
name	string	是	罐名称	"#1号罐"
stockWarehouseId	integer(int64)	是	仓库ID	1
maxVolume	number(double)	否	最大体积
alarmVolume	number(double)	否	禁戒体积
createBy	integer(int64)	否	创建人ID	1
createTime	string(date-time)	否	创建时间	"2020-10-11 13:09:11"
updateBy	integer(int64)	否	修改人ID	1
updateTime	string(date-time)	否	修改时间	"2020-10-11 13:09:11"

罐-规格信息

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
tankId	integer(int64)	是	油罐ID
height	number(double)	是	油罐高度	1
volume	number(double)	是	油罐体积
seq	integer(int32)	否	排序
createBy	integer(int64)	否	创建人ID	1
createTime	string(date-time)	否	创建时间	"2020-10-11 13:09:11"
updateBy	integer(int64)	否	修改人ID	1
updateTime	string(date-time)	否	修改时间	"2020-10-11 13:09:11"

订单商品

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
orderId	integer(int64)	是	订单ID	1
lineNo	integer(int32)	是	行号	1
goodsId	integer(int64)	是	商品ID	1
goodsTypeId	integer(int64)	是	商品类型ID	1
goodsCode	string	是	商品编号	12532534235
goodsBarcodeId	integer(int64)	是	商品条码ID	1
goodsBarcode	string	是	商品条码	4719324252342
name	string	是	商品名称	"洗发水"
image	string	否	商品图片
vatRatio	number(double)	否	商品税率	0.5
cost	number(double)	否	商品成本	0
price	number(double)	是	商品单价	35
qty	integer(int32)	是	商品数量	1
weight	number(double)	否	商品重量【以千克为单位】	"null"
pack	string	是	包装	"瓶"
amount	number(double)	是	金额	35
brandId	integer(int64)	否	商品品牌ID	1
rmItemId	integer(int64)	是	零管商品ID	1
rmItemBarcodeId	integer(int64)	是	零管商品条码ID	1
createBy	integer(int64)	否	创建人ID	1
createTime	string(date-time)	否	创建时间	"2020-10-11 13:09:11"
updateBy	integer(int64)	否	修改人ID	1
updateTime	string(date-time)	否	修改时间	"2020-10-11 13:09:11"

订单油品

名称	类型	必填	说明	示例
id	integer(int64)	是	ID	1
companyId	integer(int64)	是	公司ID	1
posId	integer(int64)	否	机台ID	1
shiftNo	integer(int32)	否	班次号	1
orderId	integer(int64)	是	订单ID	1
orderItem	订单商品	是	订单品项
tank	string	是	油罐	1
pump	string	是	油泵	1
nozzle	string	是	油枪	1
pumpStartNumber	number(double)	是	起泵码	100
pumpEndNumber	number(double)	是	止泵码	150
machineOut	number(double)	是	油机付出	50
tradCode	string	是	交易号	12345
tradTime	string(date-time)	是	交易时间	"2020-11-11 10:20:39"
createBy	integer(int64)	否	创建人ID	1
createTime	string(date-time)	否	创建时间	"2020-10-11 13:09:11"
updateBy	integer(int64)	否	修改人ID	1
updateTime	string(date-time)	否	修改时间	"2020-10-11 13:09:11"