PrintApiApi
| Method | HTTP request | Description |
|---|---|---|
| cancelPrintEnrollmentsBulkOperation | DELETE /api/web/v1/print/cancel/{id} | Cancel print enrollments bulk operation |
| downloadPrintEnrollmentsBulkOperationLogs | GET /api/web/v1/print/download/logs/{id} | Download print enrollments bulk operation logs |
| downloadPrintEnrollmentsLogsV2 | GET /api/web/v2/print/download/logs/{id} | Download print enrollments logs V2 |
| getPrintEnrollmentsBulkOperationDetails | GET /api/web/v1/print | Get all bulk print enrollments request(s) |
| getPrintRequestDetails | GET /api/web/v1/print/{id} | Get print request details |
| printEnrollmentsBulkOperation | POST /api/web/v1/print | Create bulk print enrollment request |
| printEnrollmentsBulkOperationV2 | POST /api/web/v2/print | Create bulk print enrollment request V2 |
| singleEnrollmentPrint | POST /api/web/v1/print/single | Print single enrollment |
cancelPrintEnrollmentsBulkOperation
cancelPrintEnrollmentsBulkOperation(id)
Cancel print enrollments bulk operation
Cancel print enrollments 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 | - |
downloadPrintEnrollmentsBulkOperationLogs
downloadPrintEnrollmentsBulkOperationLogs(id)
Download print enrollments bulk operation logs
Download logs for print enrollments 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 | - |
downloadPrintEnrollmentsLogsV2
downloadPrintEnrollmentsLogsV2(id)
Download print enrollments logs V2
Download logs for print enrollments. Caller requires the issuance view permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The request 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 | - |
getPrintEnrollmentsBulkOperationDetails
List<BulkPrintOperationDetails> getPrintEnrollmentsBulkOperationDetails()
Get all bulk print enrollments request(s)
Get all print enrollments request(s). Caller requires the issuance view permission to access this resource.
Example
Parameters
This endpoint does not need any parameter.
Return type
List<BulkPrintOperationDetails>
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 | - |
getPrintRequestDetails
PrintRequestDetails getPrintRequestDetails(id)
Get print request details
Get print request details. Caller requires the issuance view permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The print 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 | - |
printEnrollmentsBulkOperation
BulkPrintOperationDetails printEnrollmentsBulkOperation(enrollmentMultiPrintApiRequestV1)
Create bulk print enrollment request
Create bulk print enrollment request. Caller requires the issuance add permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentMultiPrintApiRequestV1 | EnrollmentMultiPrintApiRequestV1 |
Return type
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 | - |
printEnrollmentsBulkOperationV2
BulkPrintOperationDetails printEnrollmentsBulkOperationV2(enrollmentMultiPrintApiRequestV2)
Create bulk print enrollment request V2
Create bulk print enrollment 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 |
|---|---|---|---|
| enrollmentMultiPrintApiRequestV2 | EnrollmentMultiPrintApiRequestV2 |
Return type
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 | - |
singleEnrollmentPrint
EnrollmentPrintApiResponse singleEnrollmentPrint(enrollmentPrintApiRequestV1)
Print single enrollment
Prints a single enrollment by Design Name or Enrollment ID. Caller requires the ISSUANCE:ADD permission to access this resource.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentPrintApiRequestV1 | EnrollmentPrintApiRequestV1 |
Return type
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 | - |