com.jfinal.weixin.sdk.api

## 类 CardApi

- java.lang.Object
- - com.jfinal.weixin.sdk.api.CardApi

-     public class CardApi
      extends Object

  卡券相关接口 Created by L.cm on 2016/6/16.

- - ### 构造器概要

    构造器
    构造器和说明
    `CardApi()`

  - ### 方法概要

    所有方法 静态方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static ApiResult` | `create(String jsonStr)` 创建会员卡接口
    `static ApiResult` | `createLandingPage(String jsonStr)` 创建货架接口
    `static ApiResult` | `createQrcode(String jsonStr)` 创建二维码接口
    `static ApiResult` | `delete(String cardId)` 删除卡券接口
    `static ApiResult` | `get(String cardId)` 查看卡券详情
    `static ApiResult` | `getBatch(int offset, int count)` 批量查询卡券列表
    `static ApiResult` | `getBatch(int offset, int count, List<String> statusList)` 批量查询卡券列表
    `static ApiResult` | `gethtmlMpnews(String cardId)` 图文消息群发卡券
    `static ApiResult` | `getUserCardList(String openid)` 获取用户已领取卡券接口
    `static ApiResult` | `getUserCardList(String openid, String cardId)` 获取用户已领取卡券接口
    `static ApiResult` | `modifystock(String cardId, int stockValue)` 修改库存接口
    `static ApiResult` | `setPaycell(String cardId, boolean isOpen)` 设置买单接口
    `static ApiResult` | `setSelfconsumecell(String cardId, boolean isOpen)` 设置自助核销接口
    `static ApiResult` | `setSelfconsumecell(String cardId, boolean isOpen, boolean needVerifyCod, boolean needRemarkAmount)` 设置自助核销接口
    `static ApiResult` | `setTestWhiteList(String jsonStr)` 设置测试白名单
    `static ApiResult` | `unavailableByCard(String cardId, String reason)` 设置卡券失效接口,自定义code卡券的请求。
    `static ApiResult` | `unavailableByCode(String code, String reason)` 设置卡券失效接口,自定义卡券的请求
    `static ApiResult` | `update(String jsonStr)` 更改卡券信息接口

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### CardApi

          public CardApi()

  - ### 方法详细资料

    - #### create

          public static ApiResult create(String jsonStr)

      创建会员卡接口
      参数:
        `jsonStr` - JSON数据
      返回:
        {ApiResult}

    - #### createQrcode

          public static ApiResult createQrcode(String jsonStr)

      创建二维码接口
      参数:
        `jsonStr` - JSON数据
      返回:
        {ApiResult}

    - #### createLandingPage

          public static ApiResult createLandingPage(String jsonStr)

      创建货架接口
      参数:
        `jsonStr` - JSON数据
      返回:
        {ApiResult}

    - #### gethtmlMpnews

          public static ApiResult gethtmlMpnews(String cardId)

      图文消息群发卡券
      参数:
        `cardId` - 必填 否 卡券ID。
      返回:
        {ApiResult}

    - #### setTestWhiteList

          public static ApiResult setTestWhiteList(String jsonStr)

      设置测试白名单
      参数:
        `jsonStr` - JSON数据
      返回:
        {ApiResult}

    - #### setPaycell

          public static ApiResult setPaycell(String cardId,
                                             boolean isOpen)

      设置买单接口
      参数:
        `cardId` - 卡券ID
        `isOpen` - 是否开启买单功能，填true/false
      返回:
        {ApiResult}

    - #### setSelfconsumecell

          public static ApiResult setSelfconsumecell(String cardId,
                                                     boolean isOpen)

      设置自助核销接口
      参数:
        `cardId` - 卡券ID
        `isOpen` - 是否开启买单功能，填true/false
      返回:
        {ApiResult}

    - #### setSelfconsumecell

          public static ApiResult setSelfconsumecell(String cardId,
                                                     boolean isOpen,
                                                     boolean needVerifyCod,
                                                     boolean needRemarkAmount)

      设置自助核销接口
      参数:
        `cardId` - 卡券ID
        `isOpen` - 是否开启买单功能，填true/false
        `needVerifyCod` - 用户核销时是否需要输入验证码，填true/false，默认为false
        `needRemarkAmount` - 用户核销时是否需要备注核销金额，填true/false，默认为false
      返回:
        {ApiResult}

    - #### getUserCardList

          public static ApiResult getUserCardList(String openid)

      获取用户已领取卡券接口
      参数:
        `openid` - 是 string(64) 需要查询的用户openid
      返回:
        {ApiResult}

    - #### getUserCardList

          public static ApiResult getUserCardList(String openid,
                                                  String cardId)

      获取用户已领取卡券接口
      参数:
        `openid` - 是 string(64) 需要查询的用户openid
        `cardId` - 否 string(32) 卡券ID。不填写时默认查询当前appid下的卡券。
      返回:
        {ApiResult}

    - #### get

          public static ApiResult get(String cardId)

      查看卡券详情
      参数:
        `cardId` - 卡券ID
      返回:
        {ApiResult}

    - #### getBatch

          public static ApiResult getBatch(int offset,
                                           int count)

      批量查询卡券列表
      参数:
        `offset` - 查询卡列表的起始偏移量，从0开始，即offset: 5是指从从列表里的第六个开始读取。
        `count` - 需要查询的卡片的数量（数量最大50）。
      返回:
        {ApiResult}

    - #### getBatch

          public static ApiResult getBatch(int offset,
                                           int count,
                                           List<String> statusList)

      批量查询卡券列表
      参数:
        `offset` - 查询卡列表的起始偏移量，从0开始，即offset: 5是指从从列表里的第六个开始读取。
        `count` - 需要查询的卡片的数量（数量最大50）。
        `statusList` - 支持开发者拉出指定状态的卡券列表“CARD_STATUS_NOT_VERIFY”,待审核；“CARD_STATUS_VERIFY_FAIL”,审核失败；“CARD_STATUS_VERIFY_OK”，通过审核；“CARD_STATUS_DELETE”，卡券被商户删除；“CARD_STATUS_DISPATCH”在公众平台投放过的卡券；
      返回:
        {ApiResult}

    - #### update

          public static ApiResult update(String jsonStr)

      更改卡券信息接口
      参数:
        `jsonStr` - JSON数据
      返回:
        {ApiResult}

    - #### modifystock

          public static ApiResult modifystock(String cardId,
                                              int stockValue)

      修改库存接口
      参数:
        `cardId` - 卡券ID
        `stockValue` - 增减的库存数量 负数为减，正数为增加,0不增不减。
      返回:
        {ApiResult}

    - #### delete

          public static ApiResult delete(String cardId)

      删除卡券接口
      参数:
        `cardId` - 卡券ID
      返回:
        {ApiResult}

    - #### unavailableByCode

          public static ApiResult unavailableByCode(String code,
                                                    String reason)

      设置卡券失效接口,自定义卡券的请求
      参数:
        `code` - 设置失效的Code码。
        `reason` - 用户发生退款 失效理由
      返回:
        {ApiResult}

    - #### unavailableByCard

          public static ApiResult unavailableByCard(String cardId,
                                                    String reason)

      设置卡券失效接口,自定义code卡券的请求。
      参数:
        `cardId` - 卡券ID
        `reason` - 用户发生退款 失效理由
      返回:
        {ApiResult}

Copyright © 2017. All rights reserved.