Protocol	HTTPS GET
Direction	Developer server -> Huawei server
URL	{url}/hmspass/v2/{cardType}/instance/{instanceId} Set the {url} variable based on the region where the server is located. For details, please refer to Wallet Server Addresses.
Data Format	Request: Content-Type: application/json Response: Content-Type: application/json

URL Parameters

Expand

Parameter	Mandatory/Optional	Type	Description
cardType	Mandatory	String	Pass type. Set this parameter as required. For supported pass types, please refer to Other Passes Supported.
instanceId	Mandatory	String	Unique identifier of an instance. It must be unique across all instances sharing the same appId. The value contains only letters, digits, dots (.), hyphens (-), and underscores (_).

Request Parameters

Request Header

Expand

Parameter	Mandatory/Optional	Type	Description
Authorization	Mandatory	String	Authorization code. For details about how to obtain the value, please refer to the Client Credentials mode in OAuth 2.0-based Authentication. In this mode, client_id and client_secret are respectively the App ID and App key of the app that you created in AppGallery Connect. Concatenate the value of access_token to the end of Bearer, with a space in between, to generate the value of Authorization.
Content-Type	Mandatory	String	The value is always application/json;charset=utf-8.
Accept	Mandatory	String	The value is always application/json;charset=utf-8.

Request Example

Collapse
Word wrap
Dark theme
Copy code
GET /hmspass/v2/key_parkcard/instance/70001 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

Response Parameters

When the result code is 200:

Expand

Parameter	Type	Description
For details, please refer to the HwWalletObject Parameters.	HwWalletObject	Pass instance that is identified by instanceId.

Response Example

Collapse
Word wrap
Dark theme
Copy code
HTTP/1.1 200 OK
Content-Type: application/json
{
  "organizationPassId": "5623489234",
  "passTypeIdentifier": "hwpass.type.parkcard.test",
  "passStyleIdentifier": "class_parkcard_Test",
  "serialNumber": "70001",
  "fields": {
    "status": {
      "state": "active",
      "effectTime": "2019-11-13T00:00:00.111Z",
      "expireTime": "2020-11-20T00:00:00.111Z"
    },
    "barCode": {
      "text": "562348969211212",
      "type": "codabar",
      "value": "562348969211212",
      "encoding": "UTF-8"
    },
    "commonFields": [
      {
        "key": "cardNumber",
        "value": "12345678"
        "label": "cardNumber"
      }
    ],
    "appendFields": [
      {
        "key": "isCreateWhiteCard",
        "value": "true",
        "label": "NFCCardFlag"
      }
    ]
  }
}

Result Codes

For details, please refer to Result Codes.

Call Example

Collapse
Word wrap
Dark theme
Copy code
public HwWalletObject getWalletModelByModelId(String url, String modelId) {
    // Construct the HTTP header.
    HttpHeaders header = constructHttpHeaders();
    // Construct the HTTP URL.
    String baseUrl = ConfigHelper.instants().getValue("walletServerBaseUrl");
    String walletServerUrl = baseUrl + url + modelId;

    // Send the HTTP request and obtain the response.
    ResponseEntity<HwWalletObject> response =
        REST_TEMPLATE.exchange(walletServerUrl, HttpMethod.GET, new HttpEntity(header), HwWalletObject.class);

    // Return the wallet model with the corresponding model ID.
    return response.getBody();
}

Adding a Pass Instance

Querying Pass Instances

Send feedback

Was this page helpful?

Send feedback

Reach out to us through the community for any other questions.

Community Q&A Intelligent Assistant