25 通用抽奖API

API列表

编号 API名称 备注
25.1.1 奖品列表
25.1.2 奖品详情
25.1.3 新增奖品
25.1.4 修改奖品
25.1.5 删除奖品
25.1.6 奖品上架/下架
25.2.1 中奖列表
25.2.2 中奖明细
25.2.3 添加中奖记录（抽奖） 内部接口
25.2.4 删除中奖记录 已禁用
25.2.5 发货（后端）
25.2.6 填写收货地址(app)
25.2.7 兑换
25.3.1 收货地址列表（app）
25.3.2 收货地址明细（app）
25.3.3 添加收货地址（app）
25.3.4 修改收货地址（app）
25.3.5 删除收货地址（app）
25.4.1 中奖记录导出
25.5.1 奖品库列表
25.5.2 奖品库奖品详情
25.5.3 新增奖品库奖品
25.5.4 修改奖品库奖品
25.5.5 删除奖品库奖品
25.6.1 我的中奖记录（app）

25.1.1: 奖品列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/list

方法：POST

请求参数

名称 位置 类型 必填 描述
commonId BODY LONG 是 通用id
commonType BODY INTEGER 是 通用类型 1-问卷
status BODY INTEGER 否 奖品状态
page BODY INTEGER 否 页数
size BODY INTEGER 否 每页数据量

请求Body描述(非Form表单数据)

{
    "commonId": 1234567,
    "commonType": 1,
    "status":1,
    "page":1,
    "size":10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
prizeId DATA LONG 是 奖品id
commonId DATA LONG 是 通用id
commonType DATA LONG 是 通用类型 1-问卷
prizeName DATA STRING 是 奖品名称
picture DATA STRING 是 奖品缩略图
prizeType DATA LONG 是 奖品类型 0-线上实物，1-线下实物
quantity DATA LONG 是 总数量
remain DATA LONG 是 剩余数量
prizeValue DATA LONG 是 价值
probability DATA DOUBLE 是 获奖概率
rule DATA STRING 是 奖品规则
startTime DATA STRING 是 奖品生效时间
endTime DATA STRING 是 奖品失效时间
status DATA INTEGER 是 奖品状态
sendMethod DATA INTEGER 是 兑换方式 0-直接使用 1-兑换码 2-需要发货
sendStatus records INTEGER 是 地址状态 0-需要填写地址 1-填写完毕
recordStatus DATA INTEGER 是 中奖奖品状态 0-待使用/兑换/发货 1-已使用/兑换/发货 2-未开始 3-已过期
current 顶层 INTEGER 是 当前页数
total 顶层 INTEGER 是 数据条数
pages 顶层 INTEGER 是 总页数
size 顶层 INTEGER 是 每页数量
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":{
        "current": 2,
        "total": 15,
        "pages": 3,
        "size": 5,
        "prizeList":[{
            "prizeId": 1,
            "commonId": 1,
            "commonType": 1,
            "prizeName": "洗衣机",
            "picture": "",
            "prizeType": 1,
            "quantity": 10,
            "remain": 5,
            "prizeValue": 888,
            "probability": 1,
            "startTime": "2019-09-01 12:27:58",
            "endTime": "2019-10-01 12:27:58",
            "status": 1,
            "sendMethod": 0
        }]
    }
}

异常返回示例

{"code":20001,"message":"暂无信息","data":{}}

25.1.2: 奖品明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
prizeId BODY LONG 是 奖品id

请求Body描述(非Form表单数据)

{
    "prizeId": 12
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
prizeId DATA LONG 是 奖品id
commonId DATA LONG 是 通用id
commonType DATA INTEGER 是 通用类型 1-问卷
prizeName DATA STRING 是 奖品名称
picture DATA STRING 是 奖品缩略图
prizeType DATA LONG 是 奖品类型 0-线上实物，1-线下实物
quantity DATA LONG 是 总数量
remain DATA LONG 是 剩余数量
prizeValue DATA LONG 是 价值
probability DATA DOUBLE 是 获奖概率
rule DATA STRING 是 奖品规则
startTime DATA STRING 是 奖品生效时间
endTime DATA STRING 是 奖品失效时间
status DATA INTEGER 是 奖品状态
sendMethod DATA INTEGER 是 兑换方式 0-直接使用 1-兑换码 2-需要发货
sendStatus records INTEGER 是 地址状态 0-需要填写地址 1-填写完毕
recordStatus DATA INTEGER 是 中奖奖品状态 0-待使用/兑换/发货 1-已使用/兑换/发货 2-未开始 3-已过期
records DATA LIST 是 中奖记录
redeemCode RECORDS STRING 是 兑换码
status RECORDS INTEGER 是 状态 0未兑换 1已兑换
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":[{
        "prizeId": 1,
        "commonId": 1,
        "commonType": 1,
        "prizeName": "洗衣机",
        "picture": "",
        "prizeType": 1,
        "quantity": 10,
        "remain": 5,
        "prizeValue": 888,
        "probability": 1,
        "startTime": "2019-09-01 12:27:58",
        "endTime": "2019-10-01 12:27:58",
        "status": 1,
        "recordStatus":0,
        "records": [
            {
                "redeemCode": "2019091579K31H",
                "status": 1
            }
        ]
    }]
}

异常返回示例

{"code":20001,"message":"暂无信息","data":{}}

25.1.3: 添加奖品

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/add

方法：POST

请求参数

名称 位置 类型 必填 描述
commonId BODY LONG 是 通用id
commonType BODY LONG 是 通用类型
prizeType LIST INTEGER 是 奖品类型 0-线上实物，1-线下实物
prizeName LIST STRING 是 奖品名称
quantity LIST LONG 是 奖品数量
prizeValue LIST LONG 是 单位价值
probability LIST DOUBLE 是 中奖概率
rule LIST STRING 否 使用规则
startTime LIST STRING 是 奖品生效时间
endTime LIST STRING 是 奖品失效时间
picture LIST STRING 否 奖品图片
sendMethod LIST STRING 是 兑换方式 0-直接使用 1-兑换码 2-需要发货

请求Body描述(非Form表单数据)

{
    "commonId":1,
    "commonType":1,
    "list":[{
        "prizeType": 1,
        "prizeName": "xxx",
        "quantity": 10,
        "prizeValue": 50,
        "probability": 10,
        "rule": "",
        "startTime": "2019-09-01 12:27:58",
        "endTime": "2019-09-01 12:27:58",
        "picture": "",
        "sendMethod":1
    }]

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"添加失败","data":{}}

25.1.4: 修改奖品信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/update

方法：POST

请求参数

名称 位置 类型 必填 描述
commonType BODY LONG 是 通用类型
prizeId BODY LONG 是 奖品id
prizeType BODY INTEGER 否 奖品类型 0-线上实物，1-线下实物
prizeName BODY STRING 否 奖品名称
quantity BODY LONG 否 奖品数量
remain BODY LONG 否 奖品剩余数量
prizeValue BODY LONG 否 单位价值
probability BODY DOUBLE 否 中奖概率
rule BODY STRING 否 使用规则
startTime BODY STRING 否 奖品生效时间
endTime BODY STRING 否 奖品失效时间
picture BODY STRING 否 奖品图片

请求Body描述(非Form表单数据)

{
    "prizeId": 1,
    "commonType": 1,
    "prizeType": 1,
    "prizeName": "xxx",
    "quantity": 10,
    "remain": 5,
    "prizeValue": 50,
    "probability": 1,
    "rule": "",
    "startTime": "2019-09-01 12:27:58",
    "endTime": "2019-09-01 12:27:58",
    "picture": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"修改失败","data":{}}

25.1.5: 删除奖品信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
prizeId BODY LONG 是 奖品id
commonType BODY LONG 是 通用类型

请求Body描述(非Form表单数据)

{
    "prizeId": 12,
    "commonType": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"删除失败","data":{}}

25.1.6: 奖品上架下架

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/update/status

方法：POST

请求参数

名称 位置 类型 必填 描述
prizeId BODY LONG 是 奖品id
commonType BODY LONG 是 通用类型
status BODY INTEGER 否 奖品状态 0-下架 1-上架

请求Body描述(非Form表单数据)

{
    "prizeId": 1,
    "commonType": 1,
    "status": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"修改失败","data":{}}

25.2.1: 中奖列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/record/list

方法：POST

请求参数

名称 位置 类型 必填 描述
commonType BODY INTEGER 是 通用类型 1-问卷
commonId BODY LONG 否 通用id
userId BODY LONG 否 用户id
search BODY STRING 否 搜索
page BODY INTEGER 否 页数
size BODY INTEGER 否 每页数据量

请求Body描述(非Form表单数据)

{
    "commonType": 1,
    "commonId": 1234567,
    "userId": 1234,
    "search": "xxx",
    "page":1,
    "size":10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
recordId DATA LONG 是 中奖记录id
commonType DATA INTEGER 是 通用类型 1-问卷
commonId DATA LONG 是 通用id
userId DATA LONG 是 用户id
userName DATA STRING 是 用户名
userPhone DATA STRING 是 用户电话
userHome DATA STRING 是 所属家庭
prizeId DATA LONG 是 奖品id
prizeName DATA STRING 是 奖品名称
picture DATA STRING 是 奖品图片
prizeType DATA INTEGER 是 奖品类型 0-线上实物，1-线下实物
prizeValue DATA LONG 是 奖品价值
rule DATA STRING 是 奖品使用规则
startTime DATA STRING 是 奖品生效时间
endTime DATA STRING 是 奖品失效时间
sendMethod DATA INTEGER 是 兑换方式 0-直接使用 1-兑换码 2-需要发货
method DATA INTEGER 是 中奖形式(1-问卷提交)
winTime DATA STRING 是 中奖时间
redeemCode DATA STRING 是 兑换码
redeemTime DATA STRING 是 兑换时间
status DATA INTEGER 是 奖品状态
operator DATA STRING 是 操作人
sendStatus DATA INTEGER 是 地址状态 0-需要填写地址 1-填写完毕
dhlName DATA STRING 是 快递公司名称
expressCode DATA STRING 是 物流单号
addressId DATA LONG 是 地址id
gainer DATA STRING 是 收件人名
gainerPhone DATA STRING 是 收件人电话
regionId DATA LONG 是 区域id
province DATA STRING 是 省
city DATA STRING 是 市
address DATA STRING 是 详细地址
operator DATA STRING 是 操作人
address DATA STRING 是 收货地址
recordStatus DATA INTEGER 是 中奖奖品状态 0-待使用/兑换/发货 1-已使用/兑换/发货 2-未开始 3-已过期
current 顶层 INTEGER 是 当前页数
total 顶层 INTEGER 是 数据条数
pages 顶层 INTEGER 是 总页数
size 顶层 INTEGER 是 每页数量
prizeCount 顶层 INTEGER 是 奖品总数
remainCount 顶层 INTEGER 是 剩余总奖品数
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":{
        "current": 2,
        "total": 15,
        "pages": 3,
        "size": 5,
        "prizeCount": 5,
        "remainCount": 2,
        "recordList":[{
            "recordId": 1,
            "activeId": 1,
            "userId": 12345,
            "userName":"",
            "userPhone":"",
            "userHome":"",
            "prizeId": 1,
            "commonType": 1,
            "commonId": 1,
            "prizeName": 1,
            "picture": "xxx",
            "prizeType": 1,
            "prizeValue": 100,
            "startTime": "2019-10-14 16:48:43",
            "endTime": "2019-10-14 16:48:43",
            "sendMethod": 1,
            "method": 1,
            "winTime": "2019-10-01 12:27:58",
            "redeemCode": "xxxxx",
            "redeemTime": "2019-10-02 12:27:58",
            "status": 1,
            "operater": "zzz",
            "sendStatus": 1,
            "dhlName": "顺丰快递",
            "expressCode": "xxxxxx",
            "addressId": 1,
            "gainer": "xx",
            "gainerPhone": "180xxxxxxx",
            "regionId": 1,
            "province":"广东省",
            "city": "佛山市",
            "address": "xxxxx",
            "recordStatus":1
        }]
    }
}

异常返回示例

{"code":20001,"message":"暂无信息","data":{}}

25.2.2: 中奖明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/record/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
recordId BODY LONG 是 记录id

请求Body描述(非Form表单数据)

{
    "recordId": 12
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
recordId DATA LONG 是 中奖记录id
activeId DATA LONG 是 活动id
userId DATA LONG 是 用户id
userName DATA STRING 是 用户名
userPhone DATA STRING 是 用户电话
userHome DATA STRING 是 所属家庭
prizeId DATA LONG 是 奖品id
commonType DATA INTEGER 是 通用类型 1-问卷
commonId DATA LONG 是 通用id
prizeName DATA STRING 是 奖品名称
picture DATA STRING 是 奖品图片
prizeType DATA INTEGER 是 奖品类型 0-线上实物，1-线下实物
prizeValue DATA LONG 是 奖品价值
rule DATA STRING 是 奖品使用规则
startTime DATA STRING 是 奖品生效时间
endTime DATA STRING 是 奖品失效时间
sendMethod DATA INTEGER 是 兑换方式 0-直接使用 1-兑换码 2-需要发货
method DATA INTEGER 是 中奖形式(1-问卷提交)
winTime DATA STRING 是 中奖时间
redeemCode DATA STRING 是 兑换码
redeemTime DATA STRING 是 兑换时间
status DATA INTEGER 是 奖品状态
operator DATA STRING 是 操作人
sendStatus DATA INTEGER 是 地址状态 0-需要填写地址 1-填写完毕
dhlName DATA STRING 是 快递公司名称
expressCode DATA STRING 是 物流单号
addressId DATA LONG 是 地址id
gainer DATA STRING 是 收件人名
gainerPhone DATA STRING 是 收件人电话
regionId DATA LONG 是 区域id
province DATA STRING 是 省
city DATA STRING 是 市
address DATA STRING 是 详细地址
operator DATA STRING 是 操作人
address DATA STRING 是 收货地址
recordStatus DATA INTEGER 是 中奖奖品状态 0-待使用/兑换/发货 1-已使用/兑换/发货 2-未开始 3-已过期
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":{
        "recordId": 1,
        "activeId": 1,
        "userId": 12345,
        "userName":"",
        "userPhone":"",
        "userHome":"",
        "prizeId": 1,
        "commonType": 1,
        "commonId": 1,
        "prizeName": 1,
        "picture": "xxx",
        "prizeType": 1,
        "prizeValue": 100,
        "startTime": "2019-10-14 16:48:43",
        "endTime": "2019-10-14 16:48:43",
        "sendMethod": 1,
        "method": 1,
        "winTime": "2019-10-01 12:27:58",
        "redeemCode": "xxxxx",
        "redeemTime": "2019-10-02 12:27:58",
        "status": 1,
        "operater": "zzz",
        "sendStatus": 1,
        "dhlName": "顺丰快递",
        "expressCode": "xxxxxx",
        "addressId": 1,
        "gainer": "xx",
        "gainerPhone": "180xxxxxxx",
        "regionId": 1,
        "province":"广东省",
        "city": "佛山市",
        "address": "xxxxx",
        "recordStatus":1
   }
}

异常返回示例

{"code":20001,"message":"暂无信息","data":{}}

25.2.3: 添加中奖记录（抽奖）

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/inner/common/prize/record/add

方法：POST

请求参数

名称 位置 类型 必填 描述
commonType BODY INTEGER 是 通用类型 1-问卷
commonId BODY LONG 是 通用id
userId BODY LONG 是 用户id
userName BODY STRING 是 用户名
userPhone BODY STRING 是 用户电话
userHome BODY STRING 是 所属家庭
method BODY INTEGER 是 中奖形式 1-问卷提交

请求Body描述(非Form表单数据)

{
    "commonType":1,
    "commonId":1,
    "userId": 1,
    "userName": "xd",
    "userPhone": "180xxxxxxxx",
    "userHome": "xx小区xx栋xxx房",
    "method": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"添加失败","data":{}}

25.2.4: 删除中奖记录

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/record/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
recordId BODY LONG 是 中奖记录id

请求Body描述(非Form表单数据)

{
    "recordId": 12
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"删除失败","data":{}}

25.2.5: 发货

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/record/update/send

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
recordId BODY LONG 是 中奖记录id
dhlName BODY STRING 是 快递公司名称
expressCode BODY STRING 是 快递单号
operator BODY STRING 是 操作人

请求Body描述(非Form表单数据)

{
    "recordId": 1,
    "dhlName": "admin",
    "expressCode": "",
    "operator": "xxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"修改失败","data":{}}

25.2.6: 填写收货地址

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/record/set/address

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
recordId BODY LONG 是 中奖记录id
addressId BODY STRING 是 地址id

请求Body描述(非Form表单数据)

{
    "recordId": 1,
    "addressId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"添加失败","data":{}}

25.2.7: 兑换

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/record/update/code

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
activeId BODY LONG 是 活动id
redeemCode BODY STRING 是 兑换码
operator BODY STRING 是 操作人

请求Body描述(非Form表单数据)

{
    "recordId": 1,
    "redeemCode": "20190909xxxxxx",
    "operator":"王萍红"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20003,"message":"修改失败","data":{}}

25.3.1: 收货地址列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/send/address/list

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
userId BODY LONG 是 登陆者id（head自带）

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
addressId DATA LONG 是 收货地址id
userId DATA LONG 是 登陆者id
gainer DATA STRING 是 收货人名称
gainerPhone DATA STRING 是 收货人电话
regionId DATA LONG 是 收货区域id
address DATA STRING 是 详细地址
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":[{
        "addressId":1,
        "userId":1,
        "gainer":"xxx",
        "gainerPhone":"123123",
        "regionId":4,
        "address":"xxxxxx"
    }]
}

异常返回示例

{"code":20001,"message":"暂无消息","data":{}}

25.3.2: 收货地址明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/send/address/detail

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
addressId BODY LONG 是 收货地址id

请求Body描述(非Form表单数据)

{
    "addressId":1    
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
addressId DATA LONG 是 收货地址id
userId DATA LONG 是 登陆者id
gainer DATA STRING 是 收货人名称
gainerPhone DATA STRING 是 收货人电话
regionId DATA LONG 是 收货区域id
provinceId DATA LONG 是 省id
city DATA LONG 是 城市
province DATA LONG 是 省
address DATA STRING 是 详细地址
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":{
        "addressId":1,
        "userId":1,
        "gainer":"xxx",
        "gainerPhone":"123123",
        "regionId":4,
        "provinceId":1,
        "city":"xx市",
        "province":"xx省",
        "address":"xxxxxx"
    }
}

异常返回示例

{"code":20001,"message":"暂无消息","data":{}}

25.3.3: 添加收货地址

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/send/address/add

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
userId BODY LONG 是 登陆者id（head自带）
gainer BODY STRING 是 收货人姓名
gainerPhone BODY STRING 是 收货人电话
regionId BODY LONG 是 收货区域id
address BODY STRING 是 收货地址

请求Body描述(非Form表单数据)

{
    "userId":1,
    "gainer":"admin",
    "gainerPhone":"123123",
    "regionId":3,
    "address":"xxxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":{}
}

异常返回示例

{"code":20002,"message":"添加失败","data":{}}

25.3.4: 修改收货地址

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/send/address/update

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
addressId BODY LONG 是 地址id
gainer BODY STRING 是 收货人姓名
gainerPhone BODY STRING 是 收货人电话
regionId BODY LONG 是 收货区域id
address BODY STRING 是 收货地址

请求Body描述(非Form表单数据)

{
    "addressId":1,
    "gainer":"admin",
    "gainerPhone":"123123",
    "regionId":1,
    "address":"xxxxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":{}
}

异常返回示例

{"code":20003,"message":"修改失败","data":{}}

25.3.5: 删除收货地址

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/send/address/delete

方法：POST

请求参数

物业

名称 位置 类型 必填 描述
addressId BODY LONG 是 地址id

请求Body描述(非Form表单数据)

{
    "addressId":1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "message": "成功",
    "data":{}
}

异常返回示例

{"code":20004,"message":"删除失败","data":{}}

25.4.1: 中奖记录导出

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/mob/report/csv/exportCommonPrizeRecordList

方法：POST

请求参数

名称 位置 类型 必填 描述
commonType BODY INTEGER 是 通用类型 1-问卷 2-活动
commonId BODY LONG 否 通用id
userId BODY LONG 否 用户id
search BODY STRING 否 搜索

请求Body描述(非Form表单数据)

{
    "commonType": 1,
    "commonId": 1234567,
    "userId": 1234,
    "search": "xxx"
}

返回信息

返回参数类型

JSON

返回参数

导出表格

返回结果示例

异常返回示例

25.5.1: 奖品库列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/lib/list

方法：POST

请求参数

名称 位置 类型 必填 描述
prizeName BODY STRING 否 奖品名称
pageNo BODY INTEGER 否 页数
pageSize BODY INTEGER 否 每页数据量

请求Body描述(非Form表单数据)

{
    "prizeName":"xx",
    "page":1,
    "size":10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
id DATA LONG 是 奖品id
prizeName DATA STRING 是 奖品名称
picture DATA STRING 是 奖品缩略图
prizeType DATA LONG 是 奖品类型 0-线上实物，1-线下实物
quantity DATA LONG 是 总数量
prizeValue DATA LONG 是 价值
probability DATA DOUBLE 是 获奖概率
rule DATA STRING 是 奖品规则
startTime DATA STRING 是 奖品生效时间
endTime DATA STRING 是 奖品失效时间
sendMethod DATA INTEGER 是 兑换方式 0-直接使用 1-兑换码 2-需要发货
current 顶层 INTEGER 是 当前页数
total 顶层 INTEGER 是 数据条数
pages 顶层 INTEGER 是 总页数
size 顶层 INTEGER 是 每页数量
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "data": {
        "current": 1,
        "total": 1,
        "size": 10,
        "libList": [
            {
                "endTime": "2020-06-18 00:00:00",
                "id": 1,
                "picture": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/1908592bc402ead529b5936f5ee77feb",
                "prizeName": "手机模型",
                "prizeType": 1,
                "prizeValue": 100.0,
                "probability": 1,
                "quantity": 10,
                "rule": "123",
                "sendMethod": 3,
                "startTime": "2020-05-18 00:00:00"
            }
        ],
        "page": 1
    },
    "message": "success"
}

25.5.2: 奖品库奖品明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/lib/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
id BODY LONG 是 奖品id

请求Body描述(非Form表单数据)

{
    "id": 12
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
id DATA LONG 是 奖品id
commonId DATA LONG 是 通用id
commonType DATA INTEGER 是 通用类型 1-问卷
prizeName DATA STRING 是 奖品名称
picture DATA STRING 是 奖品缩略图
prizeType DATA LONG 是 奖品类型 0-线上实物，1-线下实物
quantity DATA LONG 是 总数量
prizeValue DATA LONG 是 价值
probability DATA DOUBLE 是 获奖概率
rule DATA STRING 是 奖品规则
startTime DATA STRING 是 奖品生效时间
endTime DATA STRING 是 奖品失效时间
status DATA INTEGER 是 奖品状态
sendMethod DATA INTEGER 是 兑换方式 0-直接使用 1-兑换码 2-需要发货
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "data": {
        "endTime": "2020-06-18 00:00:00",
        "id": 1,
        "picture": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/1908592bc402ead529b5936f5ee77feb",
        "prizeName": "手机模型",
        "prizeType": 1,
        "prizeValue": 100.0,
        "probability": 1,
        "quantity": 10,
        "rule": "123",
        "sendMethod": 3,
        "startTime": "2020-05-18 00:00:00"
    },
    "message": "success"
}

25.5.3: 奖品库添加奖品

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/lib/add

方法：POST

请求参数

名称 位置 类型 必填 描述
prizeType LIST INTEGER 是 奖品类型 0-线上实物，1-线下实物
prizeName LIST STRING 是 奖品名称
quantity LIST LONG 是 奖品数量
prizeValue LIST LONG 是 单位价值
probability LIST DOUBLE 是 中奖概率
rule LIST STRING 否 使用规则
startTime LIST STRING 是 奖品生效时间
endTime LIST STRING 是 奖品失效时间
picture LIST STRING 否 奖品图片
sendMethod LIST STRING 是 兑换方式 0-直接使用 1-兑换码 2-需要发货

请求Body描述(非Form表单数据)

{
     "prizeName":"手机",
     "picture":"https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/1908592bc402ead529b5936f5ee77feb",
     "prizeType":"1",
     "quantity":"1",
     "prizeValue":"5999",
     "probability":"1",
     "sendMethod":3,
     "rule":"",
     "startTime":"2020-05-18 00:00:00",
     "endTime":"2020-06-18 00:00:00"
 }

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

25.5.4: 修改奖品库奖品信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/lib/update

方法：POST

请求参数

名称 位置 类型 必填 描述
id BODY LONG 是 奖品id
prizeType BODY INTEGER 否 奖品类型 0-线上实物，1-线下实物
prizeName BODY STRING 否 奖品名称
quantity BODY LONG 否 奖品数量
prizeValue BODY LONG 否 单位价值
probability BODY DOUBLE 否 中奖概率
rule BODY STRING 否 使用规则
startTime BODY STRING 否 奖品生效时间
endTime BODY STRING 否 奖品失效时间
picture BODY STRING 否 奖品图片

请求Body描述(非Form表单数据)

{
     "id":1,
     "prizeName":"手机模型",
     "picture":"https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/1908592bc402ead529b5936f5ee77feb",
     "prizeType":"1",
     "quantity":"10",
     "prizeValue":"100",
     "probability":"1",
     "sendMethod":3,
     "rule":"123",
     "startTime":"2020-05-18 00:00:00",
     "endTime":"2020-06-18 00:00:00"
 }

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

异常返回示例

{"code":20002,"message":"修改失败","data":{}}

25.5.5: 删除奖品库奖品信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/lib/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
id BODY LONG 是 奖品id

请求Body描述(非Form表单数据)

{
    "id": 12
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data":{}
}

25.6.1: 我的中奖记录

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/running/center/common/prize/record/app/my

方法：POST

请求参数

名称 位置 类型 必填 描述
myStatus BODY INTEGER 是 我的中奖状态 0-未用 1-已用 2-过期
pageNo BODY INTEGER 否 页码
pageSize BODY INTEGER 否 每页数量
userId HEAD LONG 是 用户id

请求Body描述(非Form表单数据)

{
    "myStatus": 1,
    "pageNo":1,
    "pageSize":10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
recordId records LONG 是 中将记录id
prizeName records STRING 是 奖品名称
picture records STRING 是 奖品缩略图
prizeValue records LONG 是 价值
probability records DOUBLE 是 获奖概率
startTime records STRING 是 奖品生效时间
endTime records STRING 是 奖品失效时间
sendMethod records INTEGER 是 兑换方式 0-直接使用 1-兑换码 2-需要发货
sendStatus records INTEGER 是 地址状态 0-需要填写地址 1-填写完毕
city records STRING 是 市
province records STRING 是 省
address records STRING 是 详细地址
recordStatus records INTEGER 是 中奖奖品状态 0-待使用/兑换/发货 1-已使用/兑换/发货 2-未开始 3-已过期
redeemCode records STRING 是 兑换码
current DATA INTEGER 是 当前页数
total DATA INTEGER 是 数据条数
pages DATA INTEGER 是 总页数
size DATA INTEGER 是 每页数量
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
    "code": 200,
    "data": {
        "current": 1,
        "orders": [],
        "pages": 8,
        "records": [
            {
                "address": "",
                "city": "",
                "endTime": "2020-03-24 00:00:00",
                "picture": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/1908592bc402ead529b5936f5ee77feb",
                "prizeName": "iPhone X",
                "prizeValue": 6999.0,
                "province": "",
                "recordId": 21,
                "sendMethod": 1,
                "startTime": "2020-03-17 00:00:00"
            }
        ],
        "searchCount": true,
        "size": 1,
        "total": 8
    },
    "message": "success"
}

异常返回示例

{"code":20001,"message":"暂无信息","data":{}}

results matching ""

    No results matching ""