批量查询礼品卡个人实例

功能介绍

获取属于某一礼品卡模板的所有个人化实例。

场景描述

开发者可以调用该API，查询属于某一礼品卡模板的所有个人化实例。可以按照pageSize来分页返回。

使用约束

需在华为AGC网站上创建应用并申请卡券对应的服务。需先添加个人化实例所属的卡券模板到华为钱包服务器。

接口原型

查询参数

备注：pageSize和session都不存在则返回全部对象。pageSize存在而session不存在，则返回第一组对象。pageSize和session都存在则返回下一组对象。不能填写了session而不填写pageSize。对象总数超过50时必须设置pageSize。使用session查询下一组对象时，pageSize应与之前使用的值保持一致。

请求参数

Request Header：

请求示例

GET /hmspass/v1/giftcard/instance?modelId=giftCardModelTest HTTP/1.1
Content-Type: application/json;charset=utf-8
Authorization: Bearer ***
Accept: application/json;charset=utf-8
Host: wallet-passentrust-drcn.cloud.huawei.com.cn

响应参数

错误码为200时：

PageInfo：

响应示例

HTTP/1.1 200 OK
Content-Type: application/json
{
  "data": [
    {
      "passTypeIdentifier": "hwpass.com.huawei.wallet.giftcard.test",
      "passStyleIdentifier": "giftCardModelTest",
      "organizationPassId": "356688115",
      "serialNumber": "30001",
      "fields": {
        "status": {
          "state": "active",
          "effectTime": "2019-11-13T00:00:00.111Z",
          "expireTime": "2028-11-20T00:00:00.111Z"
        },
        "barCode": {
          "text": "1118466050",
          "type": "codabar",
          "value": "1118466050",
          "encoding": "UTF-8"
        },
        "commonFields": [
          {
            "key": "cardNumber",
            "value": "356688115"
          },
          {
            "key": "balance",
            "value": "$199"
          },
          {
            "key": "balanceRefreshTime",
            "value": "Thursday, Dec 12,2018"
          },
          {
            "key": "pin",
            "value": "118.91",
            "label": "PIN Number"
          }
        ]
      }
    }
  ],
  "pageInfo": {
    "pageSize": 1
  }
}

错误码

详见错误码。

调用示例

public List<HwWalletObject> listWalletInstance(String url, String modelId, Integer pageSize) {
    // Construct the http header.
    HttpHeaders header = constructHttpHeaders();
    // Construct the http URL.
    String baseUrl = ConfigHelper.instants().getValue("walletServerBaseUrl") + url;

    HttpEntity entity = new HttpEntity(header);
    if (pageSize == null) {
        ResponseEntity<BatchGetHwWalletResult> response = REST_TEMPLATE.exchange(url + "?modelId=" + modelId, HttpMethod.GET, entity, BatchGetHwWalletResult.class);
        BatchGetHwWalletResult batchGetHwWalletResult = response.getBody();
        if (batchGetHwWalletResult == null) {
            System.out.println("listWalletInstance failed. batchGetHwWalletResult is null.");
            return null;
        } else {
            return batchGetHwWalletResult.getData();
        }
    } else {
        List<HwWalletObject> walletInstanceList = new LinkedList<>();
        String tempUrl = baseUrl + "?modelId=" + modelId + "&pageSize=" + pageSize;
        String session = "";
        while (true) {
            String finalUrl = tempUrl;
            if (!session.isEmpty()) {
                finalUrl = finalUrl + "&session=" + session;
            }
            ResponseEntity<BatchGetHwWalletResult> response =
                REST_TEMPLATE.exchange(finalUrl, HttpMethod.GET, entity, BatchGetHwWalletResult.class);
            BatchGetHwWalletResult batchGetHwWalletResult = response.getBody();
            if (batchGetHwWalletResult == null) {
                System.out.println("listWalletInstance failed. batchGetHwWalletResult is null.");
                return null;
            }
            List<HwWalletObject> data = batchGetHwWalletResult.getData();
            if (data == null || data.isEmpty()) {
                return walletInstanceList;
            }
            walletInstanceList.addAll(data);
            PageInfo pageInfo = batchGetHwWalletResult.getPageInfo();
            if (pageInfo == null) {
                System.out.println("listWalletInstance failed. pageInfo is null.");
                return null;
            }
            String nextSession = pageInfo.getNextSession();
            if (nextSession == null || nextSession.isEmpty()) {
                return walletInstanceList;
            }
            session = nextSession;
        }
    }
}