### Entitlement Details Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/338664m0 Examples of entitlement structures for different modules. ```json { "moduleExclusiveEntitlements": [ { "module": 1, "details": { "cardholderExclusiveEntitlements": 1, "guestsExclusiveEntitlements": 1, "sharedEntitlements": 0, "allowedGuestsPerUsage": 1, "maxGuestsNextUse": 1 } } ] } ``` ```json { "moduleExclusiveEntitlements": [ { "module": 4, "details": { "cardholderExclusiveEntitlements": -1, "guestsExclusiveEntitlements": 0, "sharedEntitlements": 0, "allowedGuestsPerUsage": 0, "maxGuestsNextUse": 0 } } ] } ``` -------------------------------- ### OpenAPI Schema Example Response Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540892e0 A successful response example for a membership prebooking order. ```yaml examples: '1': summary: Success value: code: 0 data: status: 1 module: 1 category: 2 membershipId: '8888000066668888' orderId: DP00000000000001 orderCreatedDate: '2024-12-31T00:00:00+00:00' ``` -------------------------------- ### Preview Order Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540886e0 Examples of success and exception responses for the order preview endpoint. ```yaml examples: '1': summary: Success value: code: 0 data: module: 1 category: 2 membershipId: '8888000066668888' extra: prebookingDate: 2025-10-01T10:30 usedEntitlementDetails: cardholderExclusiveEntitlements: 1 guestsExclusiveEntitlements: 0 sharedEntitlements: 1 purchasedEntitlements: 0 usedEntitlementBreakdown: - sourceType: module_exclusive tier: 1 entitlements: cardholderExclusiveEntitlements: 1 guestsExclusiveEntitlements: 0 sharedEntitlements: 0 cashPaymentApplied: false resourceId: N00001 resourceName: DragonPass Lounge '2': summary: Exception value: code: -1 msg: >- Temporarily unable to preview the order. Please try again later. errCode: 500.042.019 ``` -------------------------------- ### Pricing Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540879e0 Example JSON response structure for a successful resource pricing query. ```yaml example: code: 0 data: pagination: pageSize: 10 pageNumber: 1 totalNumber: 1 resourceId: E00001 resourceName: eSIM United Kingdom options: - optionId: E00001-02 optionName: eSIM United Kingdom - 10GB 5Days currency: USD lastUpdatedTime: '2025-05-01T10:00:00+00:00' pricingMode: 1 pricing: basePrice: 50 prebookingFee: null ``` -------------------------------- ### Local Offer Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540888e0 A JSON example representing the structure of a local offer resource response. ```json { "code": 0, "data": { "language": "en-US", "module": 11, "resourceId": "LO00001", "resourceName": "DragonPass Club", "locationInfo": { "city": "Manchester", "countryOrRegion": "GB", "continent": "Europe", "transportHubId": null, "transportHubName": null, "iata": "MAN", "location": "Manchester M90 1QX", "timezone": "Europe/London", "coordinates": "25.0330,121.5654" }, "businessHours": [ { "day": 1, "times": { "type": "STANDARD", "detail": "00:00-23:59" } } ], "prebookingPolicy": { "isBookable": true, "isCancelable": true, "advanceBookingHour": null, "advanceCancellationHours": null, "maxPassengerPerOrder": 1, "prebookingRequiredInfo": [] }, "serviceTerms": { "childPolicies": null, "serviceNotices": "Access is only granted with a valid voucher" }, "imagesList": [ { "url": "https://image.dragonpass.com/uploadFile/images/test.png", "order": 1 } ], "lastUpdatedTime": "2025-05-01T10:00:00+00:00", "extra": { "localOfferInfo": { "contact": "+12 1234 1234", "description": "resource description", "amenities": [ { "amenityName": "Wifi" } ] } } } } ``` -------------------------------- ### Define API Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540893e0 JSON examples for successful and failed API responses. ```json examples: '1': summary: Success value: code: 0 data: pagination: pageSize: 10 pageNumber: 1 totalNumber: 3 resourceId: E00001 resourceName: eSIM United Kingdom optionList: - optionId: E00001-01 optionName: eSIM United Kingdom - 10GB 5Days duration: 5 dataMode: 1 totalVolume: 10 unit: 1 - optionId: E00001-02 optionName: eSIM United Kingdom - 1GB 1Day duration: 1 dataMode: 1 totalVolume: 1 unit: 1 - optionId: E00001-03 optionName: eSIM United Kingdom - Unlimited 10Days duration: 10 dataMode: 2 totalVolume: -1 unit: 3 '2': summary: Exception value: code: -1 msg: >- Sorry, we’re unable to retrieve the list at the moment. Please try again later. errCode: 500.020.016 ``` -------------------------------- ### Define Request Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540860e0 Provides example payloads for updating funded and purchased entitlements. ```yaml examples: '1': value: membershipId: '8888000066668888' quantity: 1 module: 1 usageRestriction: 1 summary: Update Funded Entitlement '2': value: membershipId: '8888000066668888' purchasedQuantity: 1 module: 1 summary: Update Purchased Entitlement ``` -------------------------------- ### Define Example Response Value Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540868e0 Example structure for a lounge response object. ```yaml examples: '1': summary: Lounge value: code: 0 data: ``` -------------------------------- ### Define API Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3547521e0 Success and exception response examples for the simulation endpoint. ```yaml examples: '1': summary: Success value: code: 0 data: dpId: '1788000066668888' transactionId: DPSL00001 message: Order Created '2': summary: Exception value: code: -1 msg: >- Sorry, we’re unable to process your order at the moment. Please try again later or contact DragonPass support team. errCode: 500.000.010 ``` -------------------------------- ### Define Membership Prebooking Request Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540863e0 Example payload for creating a membership prebooking order. ```yaml example: module: 8 membershipId: '8888000066668888' extra: prebookingToken: 85c69b8e790befc7e94870ec269c3f1d cashPaymentApplied: false toUseEntitlementCount: 1 ``` -------------------------------- ### Local Offer Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3544139e0 Example response structure for a successful local offer prebooking order. ```yaml code: 0 data: status: 1 module: 11 category: 2 ePassId: '1788000066668888' orderId: DP00000000000001 orderCreatedDate: '2024-12-31T00:00:00+00:00' orderCancelledDate: null extra: clientUserId: 3EF5D065-76F8-4D3E-801A-B329D15F461A prebookingDate: 2025-10-01T10:30 usageDate: null usedUsages: 1 resourceId: GR0006118 resourceName: The Malayan Council, Dunlop vouchersList: - voucher: '668800008888' voucherType: 1 localOfferOptions: optionId: LO00001 optionName: 5% discount redemptionUrl: https://dp.com/001 voucherValidUntil: '2027-04-01T00:00:00+00:00' ``` -------------------------------- ### Success Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540866e0 Examples of successful API response objects for different service modules. ```yaml '4': summary: Success value: code: 0 data: status: 2 module: 3 category: 1 ePassId: '8888000066668888' orderId: DP00000000000001 orderCreatedDate: '2024-12-31T00:00:00+00:00' orderCancelledDate: null extra: clientUserId: 3EF5D065-76F8-4D3E-801A-B329D15F461A usageDate: '2024-12-31T00:00:00' usedUsages: 1 resourceId: R00001 resourceName: DragonPass Dining Restaurant iata: MAN transportHubName: Manchester Airport terminal: Terminal 1 city: Manchester countryOrRegion: GB ``` ```yaml '5': summary: Success value: code: 0 data: status: 2 module: 4 category: 1 ePassId: '8888000066668888' orderId: DP00000000000001 orderCreatedDate: '2024-12-31T00:00:00+00:00' orderCancelledDate: null extra: clientUserId: 3EF5D065-76F8-4D3E-801A-B329D15F461A usageDate: '2024-12-31T00:00:00' usedUsages: 1 resourceId: R00001 resourceName: DragonPass Dining Restaurant iata: MAN transportHubName: Manchester Airport terminal: Terminal 1 city: Manchester countryOrRegion: GB diningOptions: description: 30.00 USD coupon to redeem against your total bill. value: '30' currency: USD ``` ```yaml '6': summary: Success value: code: 0 data: status: 1 module: 7 category: 2 ePassId: '1788000066668888' orderId: DP00000000000001 orderCreatedDate: '2024-12-31T00:00:00+00:00' orderCancelledDate: null extra: clientUserId: 3EF5D065-76F8-4D3E-801A-B329D15F461A prebookingDate: 2025-10-01T10:30 usageDate: null usedUsages: 1 resourceId: F00001 resourceName: DragonPass Fitness Club city: Manchester countryOrRegion: GB vouchersList: - voucher: '668800008888' voucherType: 1 prebookingRequiredInfo: firstName: DragonPass lastName: DragonPass email: developer@dragonpass.com phoneNumber: '8081966002' callingCode: '44' transportNumber: string fitnessOptions: optionId: F00001-01 optionName: Day Pass ``` -------------------------------- ### Define Request Example for Resource Retrieval Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540879e0 Example payload for requesting resource information with pagination parameters. ```yaml example: module: 1 resourceId: E00001 options: - E00001-02 pageNumber: 1 pageSize: 10 ``` -------------------------------- ### Success Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3544464e0 Example of a successful API response containing pagination, resource details, and a list of offer options. ```yaml code: 0 data: pagination: pageSize: 10 pageNumber: 1 totalNumber: 2 resourceId: LO00001 resourceName: DragonPass Club optionList: - optionId: LO00001-01 optionName: 5% discount marketingTag: - '2' validity: type: 1 startTime: '2026-04-01T00:00:00+00:00' endTime: '2027-04-01T00:00:00+00:00' - optionId: LO00001-02 optionName: free drink marketingTag: - '1' validity: type: 2 value: 30 unit: DAY ``` -------------------------------- ### Local Offer API Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3544463e0 Examples of success and exception responses for the Local Offer API. ```yaml examples: '1': summary: Success value: code: 0 data: optionId: LO00001-01 optionName: 5% discount marketingTag: - '2' validity: type: 1 startTime: '2026-04-01T00:00:00+00:00' endTime: '2027-04-01T00:00:00+00:00' serviceNotices: Voucher valid for 1 order only description: >- Show QR code on your mobile device at the merchant when paying '2': summary: Exception value: code: -1 msg: >- Sorry, we’re unable to retrieve the details at the moment. Please check if the optionId is correct or try again later. errCode: 500.110.006 ``` -------------------------------- ### Request Example for Prebooking Availability Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540885e0 Example JSON payload for checking the availability of a prebooking resource. ```yaml example: ePassId: '1788000066668888' module: 7 resourceId: F00001 prebookingDate: 2025-10-01T10:30 adultCount: 1 childCount: 0 ``` -------------------------------- ### Order Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540892e0 Example of a successful order response containing entitlement breakdown and passenger details. ```yaml orderCancelledDate: null extra: prebookingDate: 2025-10-01T10:30 usageDate: '2025-10-01T10:35:26+00:00' usedEntitlementDetails: cardholderExclusiveEntitlements: 1 guestsExclusiveEntitlements: 0 sharedEntitlements: 0 purchasedEntitlements: 0 usedEntitlementBreakdown: - sourceType: module_exclusive tier: 1 entitlements: cardholderExclusiveEntitlements: 1 guestsExclusiveEntitlements: 0 sharedEntitlements: 0 purchasedEntitlements: 0 cashPaymentApplied: false passengerCounts: cardholder: 1 guests: 0 resourceId: N00001 resourceName: DragonPass Lounge iata: MAN transportHubName: Manchester Airport terminal: Terminal 1 city: Manchester countryOrRegion: GB vouchersList: - voucher: '668800008888' voucherType: 1 prebookingRequiredInfo: firstName: DragonPass lastName: DragonPass email: developer@dragonpass.com phoneNumber: '8081966002' callingCode: '44' flightNumber: EK0001 ``` -------------------------------- ### Define Pagination Field Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540873e0 Example values for pagination fields including pageSize, pageNumber, and totalNumber. ```yaml examples: - 10 ``` ```yaml examples: - 1 ``` ```yaml examples: - 100 ``` -------------------------------- ### E-pass Issuance Request Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/338667m0 Examples of creating E-passes with and without specific activation dates. ```json { "module": 1, "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A", "extra": { "firstName": "DragonPass", "lastName": "DragonPass", "expirationDate": "2028-12-31T23:59:59+00:00", "availableUsages": 1, "allowedResources": { "resourceIds": [] } } } ``` ```json { "module": 3, "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A", "extra": { "firstName": "DragonPass", "lastName": "DragonPass", "activationDate": "2028-10-31T23:59:59+00:00", "expirationDate": "2028-12-31T23:59:59+00:00", "availableUsages": 5, "allowedResources": { "resourceIds": [] } } } ``` -------------------------------- ### eSIM Resource Details Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540888e0 Example JSON response for a successful eSIM resource retrieval request. ```json example: code: 0 data: language: en-US module: 8 resourceId: E00001 resourceName: eSIM United Kingdom locationInfo: null businessHours: null prebookingPolicy: isBookable: true isCancelable: true advanceBookingHour: 48 advanceCancellationHours: null maxPassengerPerOrder: null prebookingRequiredInfo: [] serviceTerms: childPolicies: null serviceNotices: >- The eSIM must be installed and activated on a compatible mobile device within 1 year from the date of purchase. Failure to do so may result in the eSIM becoming invalid or unusable. imagesList: - url: https://image.dragonpass.com/uploadFile/images/test.png order: 1 lastUpdatedTime: '2025-05-01T10:00:00+00:00' extra: esimInfo: coverage: type: 1 regions: - GB rawText: United Kingdom ``` -------------------------------- ### Define API Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540836e0 Examples of successful and failed authentication responses used in the OpenAPI specification. ```yaml examples: '1': summary: Success value: code: 0 data: accessToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... tokenType: Bearer validUntil: 1923263999 '2': summary: Exception value: code: -1 msg: >- Invalid credentials. Please check your secret and try again. errCode: 201.000.001 ``` -------------------------------- ### Allowed Modules Configuration Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/339381m0 Example configuration showing how to define specific modules for a Cross Module E-pass program. ```json "allowedModules": [1, 3] //meaning: Lounge + Set Meal ``` -------------------------------- ### Define API Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540873e0 Example response structure for an exception scenario. ```yaml '2': summary: Exception value: code: -1 msg: >- Sorry, we’re unable to retrieve the order list at the moment. Please try again later. errCode: 500.000.005 ``` -------------------------------- ### Define Order ID Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540873e0 Example value for the unique order identifier. ```yaml examples: - DP00000000000001 ``` -------------------------------- ### Define Success Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540842e0 Example payload for a successful API response. ```yaml examples: '1': summary: Success value: code: 0 data: status: 1 module: 8 category: 2 ePassId: '1788000066668888' orderId: DP00000000000001 ``` -------------------------------- ### Fitness Schedule Response with Pricing Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/339314m0 Example response for a fitness resource schedule including option-level pricing details. ```json { "code": 0, "data": { "resourceId": "F00001", "resourceName": "DragonPass Fitness Club", "schedules": [ { "date": "2025-10-01", "optionList": [ { "optionId": "F00001-01", "optionName": "Hatha Yoga", "optionType": 2, "startTime": "10:00", "endTime": "11:00", "price": { "currency": "USD", "lastUpdatedTime": "2025-10-01T10:00:00+00:00", "pricingMode": 1, "pricing": { "basePrice": 25.0, "prebookingFee": null } } }, { "optionId": "F00001-02", "optionName": "Hatha Yoga", "optionType": 2, "startTime": "11:00", "endTime": "12:00", "price": { "currency": "USD", "lastUpdatedTime": "2025-10-01T10:00:00+00:00", "pricingMode": 1, "pricing": { "basePrice": 25.0, "prebookingFee": null } } }, { "optionId": "F00001-dayPass", "optionName": "Day Pass", "optionType": 1, "startTime": "08:00", "endTime": "20:00", "price": { "currency": "USD", "lastUpdatedTime": "2025-10-01T10:00:00+00:00", "pricingMode": 1, "pricing": { "basePrice": 10.0, "prebookingFee": null } } } ] } ] } } ``` -------------------------------- ### Define Order Date and Entitlement Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540868e0 Provides example values for order creation, cancellation, and entitlement quantities within the OpenAPI schema. ```yaml examples: - DP00000000000001 orderCreatedDate: type: string examples: - '2024-12-31T00:00:00+00:00' description: >- Specifies the date and time when an order was created.(UTC+0) orderCancelledDate: type: string description: >- Specifies the time when an order was cancelled (UTC+0, if applicable). examples: - '2024-12-31T01:00:00+00:00' nullable: true extra: type: object properties: prebookingDate: type: string format: date-time examples: - 2025-10-01T10:30 description: >- Specifies the local datetime on which the user prebooks a visit or service. usageDate: type: string description: >- Specifies the local date and time of order usage. This field is available only after the order has been used. format: date-time examples: - '2025-10-01T10:35:26' nullable: true usedEntitlementDetails: type: object description: >- Specifies the used entitlement details of this order. properties: cardholderExclusiveEntitlements: &ref_41 type: integer description: >- The quantity of the cardholder-exclusive entitlements. examples: - 1 maximum: 9999 guestsExclusiveEntitlements: &ref_42 type: integer description: >- The quantity of the guest-exclusive entitlements. examples: - 1 maximum: 9999 sharedEntitlements: &ref_43 type: integer description: >- The quantity of the entitlements that can be used by both the cardholder and their guests. examples: - 0 maximum: 9999 x-apifox-orders: - 01JN37J6AVWSZF2SNSA2S7ZEM1 - 01JN37J8CARWJQA1ZFVGVBHPF2 - 01JN37J80CQGR8HEV3G1Q8BH35 x-apifox-refs: 01JN37J6AVWSZF2SNSA2S7ZEM1: &ref_40 type: object properties: {} 01JN37J8CARWJQA1ZFVGVBHPF2: *ref_40 01JN37J80CQGR8HEV3G1Q8BH35: *ref_40 required: - cardholderExclusiveEntitlements - guestsExclusiveEntitlements - sharedEntitlements x-apifox-ignore-properties: - cardholderExclusiveEntitlements - guestsExclusiveEntitlements - sharedEntitlements usedEntitlementBreakdown: type: array items: type: object properties: sourceType: type: string enum: - module_exclusive - cross_module x-apifox-enum: ``` -------------------------------- ### Resource Data Structure Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/338421m0 Example JSON response showing the structure of various resource types including FastTrack, Dining, and Fitness services. ```json "resourceId": "C00001", "resourceName": "DragonPass FastTrack Service", "locationInfo": { "city": "Manchester", "countryOrRegion": "GB", "continent": "Europe", "transportHubId": "A00001", "transportHubName": "Manchester Airport", "iata": "MAN", "location": "FastTrack is located at the entrance to Security", "timezone": "Europe/London" }, "image": "https://image.dragonpass.com/uploadFile/images/cover.png", "extra": { "fastTrackInfo": { "routeTypes": [ 1 ], "terminal": "Terminal 1" } } }, { "module": 6, "resourceId": "R00001", "resourceName": "DragonPass Dining Restaurant", "locationInfo": { "city": "Manchester", "countryOrRegion": "GB", "continent": "Europe", "transportHubId": "A00001", "transportHubName": "Manchester Airport", "iata": "MAN", "location": "Airside - After security check and passport control", "timezone": "Europe/London" }, "image": "https://image.dragonpass.com/uploadFile/images/cover.png", "extra": { "diningInfo": { "area": 1, "routeTypes": [ 1 ], "terminal": "Terminal 1", "nearestGate": "A1", "diningOptions": [ { "module": 3, "optionName": "Set Meal", "description": "One set meal can be redeemed for each transaction.", "value": null, "currency": null }, { "module": 4, "optionName": "30 USD Coupon", "description": "30.00 USD coupon to redeem against your total bill.", "value": 30, "currency": "USD" } ], "tier": 1 } } } ], "lifestyleResources": [ { "module": 7, "resourceId": "F00001", "resourceName": "DragonPass Fitness", "locationInfo": { "city": "Manchester", "countryOrRegion": "GB", "continent": "Europe", "transportHubId": null, "transportHubName": null, "iata": "null", "location": "Manchester M90 1QX", "timezone": "Europe/London" }, "image": "https://image.dragonpass.com/uploadFile/images/cover.png", "extra": { "fitnessInfo": null } } ] } } } ``` -------------------------------- ### Prebooking Request Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540890e0 Example JSON payload for the prebooking availability check request. ```json ePassId: '1788000066668888' module: 7 resourceId: F00001 optionId: F00001-dayPass prebookingDate: 2025-10-01T10:30 adultCount: 1 childCount: 0 ``` -------------------------------- ### Membership Registration Request Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540861e0 Example payload for registering a new DragonPass membership. ```yaml example: clientUserId: 3EF5D065-76F8-4D3E-801A-B329D15F461A firstName: DragonPass lastName: DragonPass phoneNumber: '8081966002' callingCode: '44' email: developer@dragonpass.com activationDate: '2028-10-31T23:59:59+00:00' expirationDate: '2028-12-31T23:59:59+00:00' ``` -------------------------------- ### Success Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540860e0 Example of a successful response payload for updating membership entitlements. ```yaml examples: '1': summary: Success value: code: 0 data: membershipId: '8888000066668888' entitlements: moduleExclusiveEntitlements: - module: 1 details: cardholderExclusiveEntitlements: 1 ``` -------------------------------- ### Define Prebooking Request Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540850e0 Provides a concrete JSON example for a prebooking request body including nested user information. ```yaml example: module: 7 ePassId: '1788000066668888' extra: prebookingToken: 85c69b8e790befc7e94870ec269c3f1d prebookingRequiredInfo: firstName: DragonPass lastName: DragonPass email: developer@dragonpass.com phoneNumber: '8081966002' callingCode: '44' ``` -------------------------------- ### Retrieve eSIM Order Live Extended Details Response Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/338854m0 Example response containing the eSIM status, ICCID, and detailed package information including volume and coverage. ```json { "code": 0, "data": { "orderId": "DP00000000000001", "esim": { "iccid": "898600F1234567890123", "status": 1, "effectiveDate": "2024-12-31T10:00:00+00:00", "expirationDate": "2025-12-31T10:00:00+00:00" }, "esimOptions": { "optionId": "E00001-01", "optionName": "eSIM United Kingdom - 30GB 10Days", "status": 2, "duration": 10, "dataMode": 2, "volume": { "total": 32212254720, "remaining": 32212254720, "notes": "Basic Unlimited Package provides 500MB of high-speed data, with unlimited usage at a reduced speed of 48 KB/s after high-speed data is used up. High-speed data refreshes every 24 hours." }, "activationDate": "2025-10-15T10:00:00+00:00", "expirationDate": "2025-10-25T10:00:00+00:00", "speed": "5G", "providers": [ { "provider": "DragonPass", "region": "GB" } ], "coverage": { "type": 1, "regions": [ "GB" ], "rawText": "United Kingdom" } } } } ``` -------------------------------- ### Define OpenAPI Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540872e0 Example payloads for success and exception scenarios in the API response. ```yaml examples: '1': summary: Success value: code: 0 data: membershipId: '8888000066668888' status: 1 activationDate: '2028-10-31T23:59:59+00:00' expirationDate: '2028-12-31T23:59:59+00:00' '2': summary: Exception value: code: -1 msg: Membership update failed. errCode: 500.030.002 ``` -------------------------------- ### Define Description, Time, and Option Type Schemas Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540850e0 Definitions for description, start/end times, and option type properties. ```yaml description: type: object properties: description: &ref_27 type: string description: A brief description of the scheduled option. examples: - >- Book a day pass for gym access anytime during opening hours on your chosen date. x-apifox-orders: - description required: - description x-apifox-ignore-properties: [] x-apifox-folder: '' endTime: type: object properties: endTime: &ref_26 type: string description: 'The end time of the scheduled option. Format: HH:mm.' examples: - '11:00' format: time x-apifox-orders: - endTime required: - endTime x-apifox-ignore-properties: [] x-apifox-folder: '' startTime: type: object properties: startTime: &ref_25 type: string description: 'The start time of the scheduled option. Format: HH:mm.' examples: - '10:00' format: time x-apifox-orders: - startTime required: - startTime x-apifox-ignore-properties: [] x-apifox-folder: '' optionType: type: object properties: optionType: &ref_24 type: integer description: The type of option, such as daypass, class, etc. ``` -------------------------------- ### Define API Response Example Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540858e0 Example JSON response structure for an E-pass creation request. ```json example: code: 0 data: status: 1 module: 7 category: 2 ePassId: '1788000066668888' orderId: DP00000000000001 orderCreatedDate: '2024-12-31T00:00:00+00:00' orderCancelledDate: null extra: ``` -------------------------------- ### Request Example for eSIM Module Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540842e0 Example payload for an API request targeting the eSIM module. ```yaml example: module: 8 ePassId: '1788000066668888' extra: prebookingToken: 85c69b8e790befc7e94870ec269c3f1d ``` -------------------------------- ### Define Create Order Response Examples Source: https://apifox.dragonpass.com/apidoc/docs-site/6000000/3540854e0 Success and exception response structures for the Create Orders API. ```yaml examples: '1': summary: Success value: code: 0 data: status: 1 module: 2 category: 2 membershipId: '8888000066668888' orderId: DP00000000000001 orderCreatedDate: '2024-12-31T00:00:00+00:00' orderCancelledDate: null extra: prebookingDate: 2025-10-01T10:30 usageDate: '2025-10-01T10:35:26+00:00' cashPaymentApplied: false usedEntitlementDetails: cardholderExclusiveEntitlements: 1 guestsExclusiveEntitlements: 0 sharedEntitlements: 0 purchasedEntitlements: 0 usedEntitlementBreakdown: - sourceType: module_exclusive tier: 1 entitlements: cardholderExclusiveEntitlements: 1 guestsExclusiveEntitlements: 0 sharedEntitlements: 0 purchasedEntitlements: 0 passengerCounts: cardholder: 1 guests: 0 resourceId: C00001 resourceName: DragonPass Fast Track Service iata: MAN transportHubName: Manchester Airport terminal: Terminal 1 city: Manchester countryOrRegion: GB passengers: - firstName: DragonPass lastName: DragonPass passengersType: 1 leadPassenger: true vouchersList: - firstName: DragonPass lastName: DragonPass voucher: '668800008888' voucherType: 1 prebookingRequiredInfo: firstName: DragonPass lastName: DragonPass email: developer@dragonpass.com phoneNumber: '8081966002' callingCode: '44' transportNumber: EK0001 '2': summary: Exception value: code: -1 msg: >- Sorry, we’re unable to process your order at the moment. Please try again later or contact DragonPass support team. errCode: 500.051.010 ```