批量查询登机牌模板

功能介绍

获取保存在华为钱包服务器的所有登机牌模板。

场景描述

开发者可以调用该API，查询属于某一appId的所有登机牌模板。可以按照pageSize来分页返回。返回的模板可以属于多个passTypeIdentifier。

使用约束

需在华为AGC网站上创建应用并申请卡券对应的服务。

接口原型

查询参数

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

请求参数

Request Header：

请求示例

GET /hmspass/v1/flight/model 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": [
    {
      "passVersion": "1.0",
      "passTypeIdentifier": "hwpass.com.huawei.wallet.flight.test",
      "passStyleIdentifier": "flightModelTest",
      "organizationName": "XXX Airline",
      "fields": {
        "countryCode": "CN",
        "locationList": [
          {
            "longitude": "114.0679603815",
            "latitude": "22.6592051284"
          }
        ],
        "commonFields": [
          {
            "key": "logo",
            "value": "https://www.huawei.com/XXX.png"
          },
          {
            "key": "merchantName",
            "value": "XXX Airline",
            "localizedValue": "merchantNameI18N"
          },
          {
            "key": "flightNumber",
            "value": "MU2887"
          },
          {
            "key": "departureTerminal",
            "value": "T2"
          },
          {
            "key": "boardingGate",
            "value": "45"
          },
          {
            "key": "departureCity",
            "value": "Nanjing"
          },
          {
            "key": "arrivalTerminal",
            "value": "T3"
          },
          {
            "key": "arrivalCity",
            "value": "Shenzhen"
          }
        ],
        "appendFields": [
          {
            "key": "backgroundColor",
            "value": "#FF1C2635"
          }
        ],
        "imageList": [
          {
            "key": "mainImage[0]",
            "value": "https://www.huawei.com/XXX0.png"
          },
          {
            "key": "mainImage[1]",
            "value": "https://www.huawei.com/XXX1.png"
          },
          {
            "key": "mainImage[2]",
            "value": "https://www.huawei.com/XXX2.png"
          }
        ],
        "messageList": [
          {
            "key": "message[0]",
            "value": "Enjoy the journey!"
          }
        ],
        "timeList": [
          {
            "key": "departureTime",
            "value": "2020-05-09T10:30:00.010Z"
          },
          {
            "key": "scheduledDepartureTime",
            "value": "2020-05-09T10:30:00.010Z"
          },
          {
            "key": "boardingTime",
            "value": "2020-05-09T10:00:00.010Z"
          },
          {
            "key": "arrivalTime",
            "value": "2020-05-09T12:30:00.010Z"
          },
          {
            "key": "scheduledArrivalTime",
            "value": "2020-05-09T12:30:00.010Z"
          }
        ],
        "localized": [
          {
            "key": "merchantNameI18N",
            "language": "zh-cn",
            "value": "XXX 航空公司"
          },
          {
            "key": "merchantNameI18N",
            "language": "en",
            "value": "XXX Airline"
          }
        ]
      }
    }
  ],
  "pageInfo": {
    "pageSize": 1
  }
}

错误码

详见错误码。

调用示例

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

    HttpEntity entity = new HttpEntity(header);
    if (pageSize == null) {
        ResponseEntity<BatchGetHwWalletResult> response =
            REST_TEMPLATE.exchange(walletServerUrl, HttpMethod.GET, entity, BatchGetHwWalletResult.class);
        BatchGetHwWalletResult batchGetHwWalletResult = response.getBody();
        if (batchGetHwWalletResult == null) {
            System.out.println("listWalletModel failed. batchGetHwWalletResult is null.");
            return null;
        } else {
            return batchGetHwWalletResult.getData();
        }
    } else {
        List<HwWalletObject> walletModelList = new LinkedList<>();
        String tempUrl = walletServerUrl + "?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("listWalletModel failed. batchGetHwWalletResult is null.");
                return null;
            }
            List<HwWalletObject> data = batchGetHwWalletResult.getData();
            if (data == null || data.isEmpty()) {
                return walletModelList;
            }
            walletModelList.addAll(data);
            PageInfo pageInfo = batchGetHwWalletResult.getPageInfo();
            if (pageInfo == null) {
                System.out.println("listWalletModel failed. pageInfo is null.");
                return null;
            }
            String nextSession = pageInfo.getNextSession();
            if (nextSession == null || nextSession.isEmpty()) {
                return walletModelList;
            }
            session = nextSession;
        }
    }
}