dujiabo
/
zhongyouweb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
16 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: 2b98fa822c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2b98fa822c'
${ noResults }
zhongyouweb/docs/api/modules/05-points-transaction.md

20 KiB
Raw Blame History

积分流水明细

本模块共 14 个接口。源文件：api.json。

快速索引

接口名称 方法 路径 用途
新增 POST /gd_dataserver/business/points/transaction/add 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
批量新增 POST /gd_dataserver/business/points/transaction/addBatch 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
新增并返回保存的数据 POST /gd_dataserver/business/points/transaction/addReturn 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
根据属性删除 GET /gd_dataserver/business/points/transaction/delete 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
主键删除 GET /gd_dataserver/business/points/transaction/deleteById 根据主键ID删除单条记录，成功返回 data 为 null。
批量删除 GET /gd_dataserver/business/points/transaction/deleteByIds 根据ID列表批量删除记录，成功返回 data 为 null。
查询所有 GET /gd_dataserver/business/points/transaction/getAll 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
分页查询 GET /gd_dataserver/business/points/transaction/getListByPage 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
详情 GET /gd_dataserver/business/points/transaction/info 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
条件查询 GET /gd_dataserver/business/points/transaction/list 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
查询我的积分流水（APP端） GET /gd_dataserver/business/points/transaction/myList 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsTransactionLog 对象，主要字段：txnNo-流水号、userId-用户ID、bizId-业务单号、bizType-业务类型(REPORT-上报奖励/EXCHANGE-兑换扣减/REFUND-退款/APPEAL_ADD-申诉补发/APPEAL_DEDUCT-申诉扣减/MALL_DEDUCT-商城扣减/MALL_REFUND-商城退款)、amount-变动积分(正=入账，负=出账)、beforeBalance-变动前余额、afterBalance-变动后余额、status-状态(1有效/2已冲正)、createTime-创建时间。
逻辑删除 GET /gd_dataserver/business/points/transaction/removeById 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
积分冲正 POST /gd_dataserver/business/points/transaction/reverse/{logId} 根据流水ID冲正该笔积分变动，原流水标记为已冲正(status=2)，并生成反向流水。返回 data 为 boolean，true-冲正成功。
修改 POST /gd_dataserver/business/points/transaction/updateById 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。

接口详情

新增

  • 用途： 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/points/transaction/add
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addOneUsingPOST_10

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：积分流水明细
  • 必填：文档未标记
字段 必填 类型 说明 示例
afterBalance 否 integer / int32 变动后可用余额 -
afterFrozen 否 integer / int32 变动后冻结余额 -
amount 否 integer / int32 变动积分（正数=入账，负数=出账） -
beforeBalance 否 integer / int32 变动前可用余额 -
beforeFrozen 否 integer / int32 变动前冻结余额 -
bizId 否 string 业务单号 -
bizType 否 string 业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 -
createTime 否 string / date-time 创建时间 -
factoryDeptId 否 string 所属厂区部门ID -
id 否 integer / int64 主键ID -
operator 否 string 操作人 -
remark 否 string 备注 -
status 否 integer / int32 状态：1-有效 2-已冲正 -
txnNo 否 string 流水号 -
userId 否 integer / int64 用户ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

批量新增

  • 用途： 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/points/transaction/addBatch
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addBatchUsingPOST_10

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：array<积分流水明细>
  • 必填：文档未标记

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

新增并返回保存的数据

  • 用途： 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
  • 请求： POST /gd_dataserver/business/points/transaction/addReturn
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addReturnUsingPOST_10

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：积分流水明细
  • 必填：文档未标记
字段 必填 类型 说明 示例
afterBalance 否 integer / int32 变动后可用余额 -
afterFrozen 否 integer / int32 变动后冻结余额 -
amount 否 integer / int32 变动积分（正数=入账，负数=出账） -
beforeBalance 否 integer / int32 变动前可用余额 -
beforeFrozen 否 integer / int32 变动前冻结余额 -
bizId 否 string 业务单号 -
bizType 否 string 业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 -
createTime 否 string / date-time 创建时间 -
factoryDeptId 否 string 所属厂区部门ID -
id 否 integer / int64 主键ID -
operator 否 string 操作人 -
remark 否 string 备注 -
status 否 integer / int32 状态：1-有效 2-已冲正 -
txnNo 否 string 流水号 -
userId 否 integer / int64 用户ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

根据属性删除

  • 用途： 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/transaction/delete
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteUsingGET_10

参数：

字段 位置 必填 类型 说明 示例
afterBalance query 否 integer / int32 变动后可用余额 -
afterFrozen query 否 integer / int32 变动后冻结余额 -
amount query 否 integer / int32 变动积分（正数=入账，负数=出账） -
beforeBalance query 否 integer / int32 变动前可用余额 -
beforeFrozen query 否 integer / int32 变动前冻结余额 -
bizId query 否 string 业务单号 -
bizType query 否 string 业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 -
createTime query 否 string / date-time 创建时间 -
factoryDeptId query 否 string 所属厂区部门ID -
id query 否 integer / int64 主键ID -
operator query 否 string 操作人 -
remark query 否 string 备注 -
status query 否 integer / int32 状态：1-有效 2-已冲正 -
txnNo query 否 string 流水号 -
userId query 否 integer / int64 用户ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

主键删除

  • 用途： 根据主键ID删除单条记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/transaction/deleteById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteOneUsingGET_10

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

批量删除

  • 用途： 根据ID列表批量删除记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/transaction/deleteByIds
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteListUsingGET_21

参数：

字段 位置 必填 类型 说明 示例
ids query 是 string ID列表(逗号分隔) -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

查询所有

  • 用途： 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
  • 请求： GET /gd_dataserver/business/points/transaction/getAll
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getAllUsingGET_10

参数：

无

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

分页查询

  • 用途： 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
  • 请求： GET /gd_dataserver/business/points/transaction/getListByPage
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getListByPageUsingGET_11

参数：

字段 位置 必填 类型 说明 示例
afterBalance query 否 integer / int32 变动后可用余额 -
afterFrozen query 否 integer / int32 变动后冻结余额 -
amount query 否 integer / int32 变动积分（正数=入账，负数=出账） -
beforeBalance query 否 integer / int32 变动前可用余额 -
beforeFrozen query 否 integer / int32 变动前冻结余额 -
bizId query 否 string 业务单号 -
bizType query 否 string 业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 -
createTime query 否 string / date-time 创建时间 -
factoryDeptId query 否 string 所属厂区部门ID -
id query 否 integer / int64 主键ID -
operator query 否 string 操作人 -
pageNum query 是 integer / int32 页码 -
remark query 否 string 备注 -
status query 否 integer / int32 状态：1-有效 2-已冲正 -
txnNo query 否 string 流水号 -
userId query 否 integer / int64 用户ID -
pageSize query 是 integer / int32 每页条数 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

详情

  • 用途： 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
  • 请求： GET /gd_dataserver/business/points/transaction/info
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： infoUsingGET_11

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

条件查询

  • 用途： 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
  • 请求： GET /gd_dataserver/business/points/transaction/list
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getListUsingGET_10

参数：

字段 位置 必填 类型 说明 示例
afterBalance query 否 integer / int32 变动后可用余额 -
afterFrozen query 否 integer / int32 变动后冻结余额 -
amount query 否 integer / int32 变动积分（正数=入账，负数=出账） -
beforeBalance query 否 integer / int32 变动前可用余额 -
beforeFrozen query 否 integer / int32 变动前冻结余额 -
bizId query 否 string 业务单号 -
bizType query 否 string 业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 -
createTime query 否 string / date-time 创建时间 -
factoryDeptId query 否 string 所属厂区部门ID -
id query 否 integer / int64 主键ID -
operator query 否 string 操作人 -
remark query 否 string 备注 -
status query 否 integer / int32 状态：1-有效 2-已冲正 -
txnNo query 否 string 流水号 -
userId query 否 integer / int64 用户ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

查询我的积分流水（APP端）

  • 用途： 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsTransactionLog 对象，主要字段：txnNo-流水号、userId-用户ID、bizId-业务单号、bizType-业务类型(REPORT-上报奖励/EXCHANGE-兑换扣减/REFUND-退款/APPEAL_ADD-申诉补发/APPEAL_DEDUCT-申诉扣减/MALL_DEDUCT-商城扣减/MALL_REFUND-商城退款)、amount-变动积分(正=入账，负=出账)、beforeBalance-变动前余额、afterBalance-变动后余额、status-状态(1有效/2已冲正)、createTime-创建时间。
  • 请求： GET /gd_dataserver/business/points/transaction/myList
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： myListUsingGET_3

参数：

字段 位置 必填 类型 说明 示例
afterBalance query 否 integer / int32 变动后可用余额 -
afterFrozen query 否 integer / int32 变动后冻结余额 -
amount query 否 integer / int32 变动积分（正数=入账，负数=出账） -
beforeBalance query 否 integer / int32 变动前可用余额 -
beforeFrozen query 否 integer / int32 变动前冻结余额 -
bizId query 否 string 业务单号 -
bizType query 否 string 业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 -
createTime query 否 string / date-time 创建时间 -
factoryDeptId query 否 string 所属厂区部门ID -
id query 否 integer / int64 主键ID -
operator query 否 string 操作人 -
pageNum query 否 integer / int32 页码 -
remark query 否 string 备注 -
status query 否 integer / int32 状态：1-有效 2-已冲正 -
txnNo query 否 string 流水号 -
userId query 否 integer / int64 用户ID -
pageSize query 否 integer / int32 每页数量 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

逻辑删除

  • 用途： 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/transaction/removeById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteListUsingGET_20

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

积分冲正

  • 用途： 根据流水ID冲正该笔积分变动，原流水标记为已冲正(status=2)，并生成反向流水。返回 data 为 boolean，true-冲正成功。
  • 请求： POST /gd_dataserver/business/points/transaction/reverse/{logId}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： reverseTransactionUsingPOST

参数：

字段 位置 必填 类型 说明 示例
logId path 是 integer / int64 原流水ID -
reason query 否 string 冲正原因 -
operator query 是 string 操作人 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

修改

  • 用途： 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/points/transaction/updateById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： updateByIdUsingPOST_11

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：积分流水明细
  • 必填：文档未标记
字段 必填 类型 说明 示例
afterBalance 否 integer / int32 变动后可用余额 -
afterFrozen 否 integer / int32 变动后冻结余额 -
amount 否 integer / int32 变动积分（正数=入账，负数=出账） -
beforeBalance 否 integer / int32 变动前可用余额 -
beforeFrozen 否 integer / int32 变动前冻结余额 -
bizId 否 string 业务单号 -
bizType 否 string 业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 -
createTime 否 string / date-time 创建时间 -
factoryDeptId 否 string 所属厂区部门ID -
id 否 integer / int64 主键ID -
operator 否 string 操作人 -
remark 否 string 备注 -
status 否 integer / int32 状态：1-有效 2-已冲正 -
txnNo 否 string 流水号 -
userId 否 integer / int64 用户ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -