接口描述:

  • 获取二维码列表。

请求 URL:

  • http|https://host/api/v1/qrcode/method/get.qrcode.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
name string max:64 物料 二维码名称
size integer between:0,10 3 二维码图片大小
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc desc asc 排序方式
order_field string in:qrcode_id,size qrcode_id size 排序字段

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 3 合计计数
items 类型 是否返回 示例值 描述
qrcode_id integer 3 二维码编号
name string 实体店物料 二维码名称
text string http://careyshop.cn 二维码内容
size integer 3 二维码图片大小 0=系统默认
logo string logo.png 二维码LOGO

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "qrcode_id": 3,
  8. "name": "实体店物料",
  9. "text": "http://careyshop.cn",
  10. "size": 3,
  11. "logo": "logo.png"
  12. },
  13. {
  14. "qrcode_id": 2,
  15. "name": "线下物料",
  16. "text": "http://www.careyshop.cn",
  17. "size": 0,
  18. "logo": ""
  19. },
  20. {
  21. "qrcode_id": 1,
  22. "name": "微信物料",
  23. "text": "纯文本内容",
  24. "size": 4,
  25. "logo": "http://careyshop.oruei.com/uploads/files/20180607/81ec85d0fcffd6229e130f3c475fa2e4.jpg?type=careyshop"
  26. }
  27. ],
  28. "total_result": 3
  29. }
  30. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2018-06-08 15:59