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
void CancelMobileFlashPassBulkOperation (string id)
Cancel mobile flash pass bulk operation
Cancel mobile flash pass bulk operation. Caller requires the issuance remove permission to access this resource.
Using the CancelMobileFlashPassBulkOperationWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The bulk operation ID |
Return type
void (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 (string enrollmentId, string 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
Using the DownloadAppleMobileFlashPassWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string enrollmentId, string 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
Using the DownloadGoogleMobileFlashPassWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
void DownloadMFPBulkOperationLogs (string 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
Using the DownloadMFPBulkOperationLogsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The bulk operation ID |
Return type
void (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
FileParameter DownloadMFPLogsV2 (string 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
Using the DownloadMFPLogsV2WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string walletType, string 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
Using the GetFlashPassDownloadURIWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
Using the GetIssueMFPBulkOperationDetailsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string id)
Get mobile flash pass request details
Get mobile flash pass request details. Caller requires the issuance view permission to access this resource.
Example
Using the GetMobileFlashPassRequestDetailsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 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
Using the IssueMobileFlashPassBulkOperationWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 enrollmentMultiFlashPassApiRequestV2)
Create bulk mobile flash pass request V2
Create bulk mobile flash pass request. Caller requires the ISSUANCE:ADD permission to access this resource.
Note: Request body payload must not exceed 200 KB.
Example
Using the IssueMobileFlashPassBulkOperationV2WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 | - |