MobileFlashPassApiApi
| Method | HTTP request | Description |
|---|---|---|
| cancelMobileFlashPassBulkOperation | DELETE /api/web/v1/mobileFlashPass/cancel/{id} | Cancel mobile flash pass bulk operation |
| downloadAppleMobileFlashPass | GET /api/web/v1/mobileFlashPass/downloads/apple/{enrollmentId}/{claimToken} | Download Apple Wallet mobile flash pass. |
| downloadGoogleMobileFlashPass | GET /api/web/v1/mobileFlashPass/downloads/google/{enrollmentId}/{claimToken} | Download Google Wallet mobile flash pass. |
| downloadMFPBulkOperationLogs | GET /api/web/v1/mobileFlashPass/download/logs/{id} | Download mobile flash pass bulk operation logs |
| downloadMFPLogsV2 | GET /api/web/v2/mobileFlashPass/download/logs/{id} | Download mobile flash pass logs V2 |
| getFlashPassDownloadURI | GET /api/web/v1/mobileFlashPass/downloadUri/{walletType}/{enrollmentId} | Get mobile flash pass download URI |
| getIssueMFPBulkOperationDetails | GET /api/web/v1/mobileFlashPass | Get all issued bulk mobile flash pass request(s) |
| getMobileFlashPassRequestDetails | GET /api/web/v1/mobileFlashPass/{id} | Get mobile flash pass request details |
| issueMobileFlashPassBulkOperation | POST /api/web/v1/mobileFlashPass | Create bulk mobile flash pass request (Deprecated) |
| issueMobileFlashPassBulkOperationV2 | POST /api/web/v2/mobileFlashPass | Create bulk mobile flash pass request V2 |
cancelMobileFlashPassBulkOperation
cancelMobileFlashPassBulkOperation(id)
Cancel mobile flash pass bulk operation
Cancel mobile flash pass bulk operation. Caller requires the issuance remove permission to access this resource.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The bulk operation ID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
downloadAppleMobileFlashPass
byte[] downloadAppleMobileFlashPass(enrollmentId, claimToken)
Download Apple Wallet mobile flash pass.
Downloads a single Apple Wallet mobile flash pass. Caller requires the ISSUANCE:VIEW permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentId | String | The unique enrollment ID obtained from Read Enrollments request. | |
| claimToken | String | The Apple Wallet random claim token. |
Return type
byte[]
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.apple.pkpass, application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
downloadGoogleMobileFlashPass
String downloadGoogleMobileFlashPass(enrollmentId, claimToken)
Download Google Wallet mobile flash pass.
Returns a single Google Wallet mobile flash pass URL for download. Caller requires the ISSUANCE:VIEW permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentId | String | The unique enrollment ID obtained from Read Enrollments request. | |
| claimToken | String | The Google Wallet random claim token. |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
downloadMFPBulkOperationLogs
downloadMFPBulkOperationLogs(id)
Download mobile flash pass bulk operation logs
Download logs for mobile flash pass bulk operation. Caller requires the issuance view permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The bulk operation ID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
downloadMFPLogsV2
File downloadMFPLogsV2(id)
Download mobile flash pass logs V2
Download logs for mobile flash pass. Produces a JSON file attachment. Caller requires the issuance view permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The bulk operation ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/octet-stream, application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
getFlashPassDownloadURI
String getFlashPassDownloadURI(walletType, enrollmentId)
Get mobile flash pass download URI
Retrieves the Mobile Flash Pass download URI for the specified wallet and enrollment. Caller requires the ISSUANCE:VIEW permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| walletType | String | The wallet to retrieve the download URI for. | |
| enrollmentId | String | The unique enrollment ID obtained from Read Enrollments request. |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
getIssueMFPBulkOperationDetails
List<IssueMobileFlashPassBulkOperationDetails> getIssueMFPBulkOperationDetails()
Get all issued bulk mobile flash pass request(s)
Get all issued bulk mobile flash pass request(s). Caller requires the issuance view permission to access this resource.
Example
Parameters
This endpoint does not need any parameter.
Return type
List<IssueMobileFlashPassBulkOperationDetails>
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
getMobileFlashPassRequestDetails
MobileFlashPassRequestDetails getMobileFlashPassRequestDetails(id)
Get mobile flash pass request details
Get mobile flash pass request details. Caller requires the issuance view permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The mobile flash pass request id |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 403 | Forbidden | - |
| 404 | The specified resource was not found | - |
| 409 | Conflict | - |
| 500 | Unexpected error | - |
issueMobileFlashPassBulkOperation
IssueMobileFlashPassBulkOperationDetails issueMobileFlashPassBulkOperation(enrollmentMultiFlashPassApiRequestV1)
Create bulk mobile flash pass request (Deprecated)
Create bulk mobile flash pass request. Caller requires the issuance add permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentMultiFlashPassApiRequestV1 | EnrollmentMultiFlashPassApiRequestV1 |
Return type
IssueMobileFlashPassBulkOperationDetails
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
issueMobileFlashPassBulkOperationV2
IssueMobileFlashPassBulkOperationDetails issueMobileFlashPassBulkOperationV2(enrollmentMultiFlashPassApiRequestV2)
Create bulk mobile flash pass request V2
Create bulk mobile flash pass request. Caller requires the ISSUANCE:ADD permission to access this resource.
<b>Note:</b> Request body payload must not exceed 200 KB.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentMultiFlashPassApiRequestV2 | EnrollmentMultiFlashPassApiRequestV2 |
Return type
IssueMobileFlashPassBulkOperationDetails
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |