PrintAPIApi
| Method | HTTP request | Description |
|---|---|---|
| cancel_print_enrollments_bulk_operation | DELETE /api/web/v1/print/cancel/{id} | Cancel print enrollments bulk operation |
| download_print_enrollments_bulk_operation_logs | GET /api/web/v1/print/download/logs/{id} | Download print enrollments bulk operation logs |
| download_print_enrollments_logs_v2 | GET /api/web/v2/print/download/logs/{id} | Download print enrollments logs V2 |
| get_print_enrollments_bulk_operation_details | GET /api/web/v1/print | Get all bulk print enrollments request(s) |
| get_print_request_details | GET /api/web/v1/print/{id} | Get print request details |
| print_enrollments_bulk_operation | POST /api/web/v1/print | Create bulk print enrollment request |
| print_enrollments_bulk_operation_v2 | POST /api/web/v2/print | Create bulk print enrollment request V2 |
| single_enrollment_print | POST /api/web/v1/print/single | Print single enrollment |
cancel_print_enrollments_bulk_operation
cancel_print_enrollments_bulk_operation(id)
Cancel print enrollments bulk operation
Cancel print enrollments bulk operation. Caller requires the issuance remove permission to access this resource.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
download_print_enrollments_bulk_operation_logs
download_print_enrollments_bulk_operation_logs(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
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
download_print_enrollments_logs_v2
download_print_enrollments_logs_v2(id)
Download print enrollments logs V2
Download logs for print enrollments. Caller requires the issuance view permission to access this resource.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The request 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 | - |
get_print_enrollments_bulk_operation_details
List[BulkPrintOperationDetails] get_print_enrollments_bulk_operation_details()
Get all bulk print enrollments request(s)
Get all print enrollments request(s). Caller requires the issuance view permission to access this resource.
Example
- Api Key Authentication (AdminAPIAuthentication):
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 | - |
get_print_request_details
PrintRequestDetails get_print_request_details(id)
Get print request details
Get print request details. Caller requires the issuance view permission to access this resource.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
print_enrollments_bulk_operation
BulkPrintOperationDetails print_enrollments_bulk_operation(enrollment_multi_print_api_request_v1)
Create bulk print enrollment request
Create bulk print enrollment request. Caller requires the issuance add permission to access this resource.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollment_multi_print_api_request_v1 | 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 | - |
print_enrollments_bulk_operation_v2
BulkPrintOperationDetails print_enrollments_bulk_operation_v2(enrollment_multi_print_api_request_v2)
Create bulk print enrollment request V2
Create bulk print enrollment request. Caller requires the ISSUANCE:ADD permission to access this resource.
Note: Request body payload must not exceed 200 KB.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollment_multi_print_api_request_v2 | 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 | - |
single_enrollment_print
EnrollmentPrintApiResponse single_enrollment_print(enrollment_print_api_request_v1)
Print single enrollment
Prints a single enrollment by Design Name or Enrollment ID. Caller requires the ISSUANCE:ADD permission to access this resource.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollment_print_api_request_v1 | 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 | - |