Issuing, Querying, and Cancelling an E-pass

Issue An E-pass

→ Use the /orders/{module}/ePasses endpoint to create a DragonPass E-pass order for your end users.

The system requires each clientUserId to be bound to a unique name in order to maintain user identity integrity.

You may register multiple different E-passes under the same name using the same clientUserId.

Using the same clientUserId to create E-passes with different names is not allowed and will result in a validation error.

Request

Create E-pass Order - Request

Request Example 1

{
  "module": 1,
  "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
  "extra": {
    "firstName": "DragonPass",
    "lastName": "DragonPass",
    "expirationDate": "2028-12-31T23:59:59+00:00",
    "availableUsages": 1,
    "allowedResources": {
      "resourceId": []
    }
  }
}

This E-pass is valid only for the Lounge Module, allowing usage for one person, and it can be used for all lounges specified in the program onboarding settings.

Request Example 2

{
    "module": 3,
    "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
    "extra": {
        "firstName": "DragonPass",
        "lastName": "DragonPass",
        "expirationDate": "2028-12-31T23:59:59+00:00",
        "availableUsages": 5,
        "allowedResources": {
            "resourceId": [
                "R00001"
            ]
        }
    }
}

This E-pass can be used by up to 5 passengers and is valid only for the Dining Set Meal Module at restaurant with Resources ID R00001.

Response

Create E-pass Order - Response

Response Example 1

{
    "status": 1,
    "module": 1,
    "category": 1,
    "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
    "orderId": "DP00000000000001",
    "orderCreatedDate": "2024-12-31T00:00:00+00:00",
    "orderCancelledDate": null,
    "usageDate": null,
    "extra": {
        "ePassId": "1788000066668888",
        "firstName": "DragonPass",
        "lastName": "DragonPass",
        "expirationDate": "2028-12-31T23:59:59+00:00",
        "availableUsages": 1,
        "usedUsages": 0,
        "allowedResources": {
            "resourceId": []
        }
    }
}

Retrieve E-pass Details

→ Use /orders/ePasses/search to retrieve the details of a specific E-pass order by providing the E-pass ID or Order ID.

Request

Retrieve E-pass Details - Request

{
    "orderId": "DP00000000000001"
}

Response

A successful response returns the following information about the order:

Retrieve E-pass Details - Response

{
    "code": 0,
    "data": {
        "status": 2,
        "module": 1,
        "category": 1,
        "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "ePassId": "1788000066668888",
            "firstName": "DragonPass",
            "lastName": "DragonPass",
            "expirationDate": "2028-12-31T23:59:59+00:00",
            "availableUsages": 0,
            "usedUsages": 1,
            "allowedResources": {
                "resourceIds": [
                    "N00001"
                ]
            }
        }
    }
}

Cancel An E-pass

→ Use the /orders endpoint to cancel an E-pass order.

Once the order is canceled, the E-pass will be instantly invalidated and cannot be restored.

Issuing, Querying, and Cancelling an E-pass