使用场景:
编辑器,奖品选择可见性接口
接口地址 由第三方企业开发者或中间件开放接口并在自建应用中配置查询接口
请求方式 POST
consumes ["application/json"]
produces ["application/json"]
应用权限 奖品->奖品可见性列表
请求参数
公共参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
orgId | 企业ID | body | true | String | |
appInstanceId | 应用实例ID | body | true | String | |
noticeData | 通知数据 | body | true | array | |
nonce | 签名随机数 | string | true | String | 签名随机数 |
timestamp | 签名时间戳 | long | true | Long | 签名时间戳 |
signature | 签名 | string | true | String | 签名 |
instanceAppId | 自建应用appid | String | true | String | |
thirdUid | 开放平台登陆uid | String | 非开放平台用户为空 | String | |
thirdCompanyId | 开放平台登陆componyId | String | 非开放平台用户为空 | String |
奖品可见性查询参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
prizeName | 查询奖品名称 | body | false | String | 编辑器奖品选择列表,左上角输入框输入就有值。 |
appId | 作品Id | body | true | String | |
componyId | 开放平台登陆componyId | body | true | String | |
uid | 开放平台登陆 uid | body | true | string | |
pageIndex | 页码 | body | true | Integer | |
pageSize | 页面大小 | body | true | Integer |
请求示例
|
响应参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
code | 状态码 | body | true | string | |
msg | 描述 | body | true | string | |
data | 返回内容 | body |
data实体
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
callbackSuccessData | 成功数据 | List | 是 | 大小为pageSize规定的大小 |
成功实体
参数名称 | 参数说明 | 数据类型 | 是否必须 | schema |
---|---|---|---|---|
totalCount | 总数量 | Integer | true | 可见奖品,总数量 |
data | 分页数据 | List<Object> | true |
data实体
参数名称 | 参数说明 | 数据类型 | 是否必须 | schema |
---|---|---|---|---|
visibleCount | 可见数量 | Integer | true | 非零:列表显示该值。 0:显示库存可用数量 |
thirdPrizeId | 外部奖品id | String | true | 可见的奖品id |
响应示例
|
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found | |
500 | FAIL |