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.
15 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: 1b9570aff9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1b9570aff9'
${ noResults }
zhongyouweb/docs/api/modules/04-points-balance.md

16 KiB
Raw Blame History

用户积分账户

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

快速索引

接口名称 方法 路径 用途
新增 POST /gd_dataserver/business/points/balance/add 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
批量新增 POST /gd_dataserver/business/points/balance/addBatch 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
新增并返回保存的数据 POST /gd_dataserver/business/points/balance/addReturn 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
手动调整积分（PC管理端） POST /gd_dataserver/business/points/balance/adjust 管理员手动补发或扣减指定用户的积分。points为正数补发，为负数扣减。操作会同时生成积分流水（bizType=MANUAL_ADD/MANUAL_DEDUCT）和审计日志。返回 data 为 boolean，true-调整成功。
根据属性删除 GET /gd_dataserver/business/points/balance/delete 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
主键删除 GET /gd_dataserver/business/points/balance/deleteById 根据主键ID删除单条记录，成功返回 data 为 null。
批量删除 GET /gd_dataserver/business/points/balance/deleteByIds 根据ID列表批量删除记录，成功返回 data 为 null。
查询所有 GET /gd_dataserver/business/points/balance/getAll 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
查询用户积分账户 GET /gd_dataserver/business/points/balance/getByUserId/{userId} 返回 data 为 AccountBalance 对象。字段：userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。
分页查询 GET /gd_dataserver/business/points/balance/getListByPage 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
详情 GET /gd_dataserver/business/points/balance/info 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
条件查询 GET /gd_dataserver/business/points/balance/list 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
查询当前用户积分账户（APP端） GET /gd_dataserver/business/points/balance/my 返回 data 为 AccountBalance 对象。字段：userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。
逻辑删除 GET /gd_dataserver/business/points/balance/removeById 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
修改 POST /gd_dataserver/business/points/balance/updateById 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。

接口详情

新增

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：用户积分账户
  • 必填：文档未标记
字段 必填 类型 说明 示例
availableBalance 否 integer / int32 可用积分余额 -
createTime 否 string / date-time 创建时间 -
frozenBalance 否 integer / int32 冻结积分余额 -
id 否 integer / int64 主键ID -
totalIncome 否 integer / int32 历史总入账积分 -
totalOutcome 否 integer / int32 历史总出账积分 -
updateTime 否 string / date-time 更新时间 -
userId 否 integer / int64 用户ID -
version 否 integer / int32 乐观锁版本号 -

响应：

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

批量新增

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

参数：

无

请求体：

  • 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/balance/addReturn
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addReturnUsingPOST

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：用户积分账户
  • 必填：文档未标记
字段 必填 类型 说明 示例
availableBalance 否 integer / int32 可用积分余额 -
createTime 否 string / date-time 创建时间 -
frozenBalance 否 integer / int32 冻结积分余额 -
id 否 integer / int64 主键ID -
totalIncome 否 integer / int32 历史总入账积分 -
totalOutcome 否 integer / int32 历史总出账积分 -
updateTime 否 string / date-time 更新时间 -
userId 否 integer / int64 用户ID -
version 否 integer / int32 乐观锁版本号 -

响应：

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

手动调整积分（PC管理端）

  • 用途： 管理员手动补发或扣减指定用户的积分。points为正数补发，为负数扣减。操作会同时生成积分流水（bizType=MANUAL_ADD/MANUAL_DEDUCT）和审计日志。返回 data 为 boolean，true-调整成功。
  • 请求： POST /gd_dataserver/business/points/balance/adjust
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： adjustPointsUsingPOST

参数：

无

请求体：

  • Content-Type：application/x-www-form-urlencoded
  • 模型：integer / int32
  • 必填：文档未标记

响应：

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

根据属性删除

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

参数：

字段 位置 必填 类型 说明 示例
availableBalance query 否 integer / int32 可用积分余额 -
createTime query 否 string / date-time 创建时间 -
frozenBalance query 否 integer / int32 冻结积分余额 -
id query 否 integer / int64 主键ID -
totalIncome query 否 integer / int32 历史总入账积分 -
totalOutcome query 否 integer / int32 历史总出账积分 -
updateTime query 否 string / date-time 更新时间 -
userId query 否 integer / int64 用户ID -
version query 否 integer / int32 乐观锁版本号 -

响应：

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

主键删除

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

参数：

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

响应：

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

批量删除

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

参数：

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

响应：

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

查询所有

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

参数：

无

响应：

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

查询用户积分账户

  • 用途： 返回 data 为 AccountBalance 对象。字段：userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。
  • 请求： GET /gd_dataserver/business/points/balance/getByUserId/{userId}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getByUserIdUsingGET

参数：

字段 位置 必填 类型 说明 示例
userId path 是 integer / int64 用户ID -

响应：

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

分页查询

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

参数：

字段 位置 必填 类型 说明 示例
availableBalance query 否 integer / int32 可用积分余额 -
createTime query 否 string / date-time 创建时间 -
frozenBalance query 否 integer / int32 冻结积分余额 -
id query 否 integer / int64 主键ID -
pageNum query 是 integer / int32 页码 -
totalIncome query 否 integer / int32 历史总入账积分 -
totalOutcome query 否 integer / int32 历史总出账积分 -
updateTime query 否 string / date-time 更新时间 -
userId query 否 integer / int64 用户ID -
version query 否 integer / int32 乐观锁版本号 -
pageSize query 是 integer / int32 每页条数 -

响应：

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

详情

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

参数：

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

响应：

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

条件查询

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

参数：

字段 位置 必填 类型 说明 示例
availableBalance query 否 integer / int32 可用积分余额 -
createTime query 否 string / date-time 创建时间 -
frozenBalance query 否 integer / int32 冻结积分余额 -
id query 否 integer / int64 主键ID -
totalIncome query 否 integer / int32 历史总入账积分 -
totalOutcome query 否 integer / int32 历史总出账积分 -
updateTime query 否 string / date-time 更新时间 -
userId query 否 integer / int64 用户ID -
version query 否 integer / int32 乐观锁版本号 -

响应：

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

查询当前用户积分账户（APP端）

  • 用途： 返回 data 为 AccountBalance 对象。字段：userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。
  • 请求： GET /gd_dataserver/business/points/balance/my
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： myBalanceUsingGET

参数：

无

响应：

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

逻辑删除

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

参数：

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

响应：

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

修改

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：用户积分账户
  • 必填：文档未标记
字段 必填 类型 说明 示例
availableBalance 否 integer / int32 可用积分余额 -
createTime 否 string / date-time 创建时间 -
frozenBalance 否 integer / int32 冻结积分余额 -
id 否 integer / int64 主键ID -
totalIncome 否 integer / int32 历史总入账积分 -
totalOutcome 否 integer / int32 历史总出账积分 -
updateTime 否 string / date-time 更新时间 -
userId 否 integer / int64 用户ID -
version 否 integer / int32 乐观锁版本号 -

响应：

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