Skip to main content

PrintAPIApi

MethodHTTP requestDescription
CancelPrintEnrollmentsBulkOperationDELETE /api/web/v1/print/cancel/{id}Cancel print enrollments bulk operation
DownloadPrintEnrollmentsBulkOperationLogsGET /api/web/v1/print/download/logs/{id}Download print enrollments bulk operation logs
DownloadPrintEnrollmentsLogsV2GET /api/web/v2/print/download/logs/{id}Download print enrollments logs V2
GetPrintEnrollmentsBulkOperationDetailsGET /api/web/v1/printGet all bulk print enrollments request(s)
GetPrintRequestDetailsGET /api/web/v1/print/{id}Get print request details
PrintEnrollmentsBulkOperationPOST /api/web/v1/printCreate bulk print enrollment request
PrintEnrollmentsBulkOperationV2POST /api/web/v2/printCreate bulk print enrollment request V2
SingleEnrollmentPrintPOST /api/web/v1/print/singlePrint single enrollment

CancelPrintEnrollmentsBulkOperation

void CancelPrintEnrollmentsBulkOperation (string id)

Cancel print enrollments bulk operation

Cancel print enrollments bulk operation. Caller requires the issuance remove permission to access this resource.

Using the CancelPrintEnrollmentsBulkOperationWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe bulk operation ID

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

DownloadPrintEnrollmentsBulkOperationLogs

void DownloadPrintEnrollmentsBulkOperationLogs (string 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

Using the DownloadPrintEnrollmentsBulkOperationLogsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe bulk operation ID

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

DownloadPrintEnrollmentsLogsV2

void DownloadPrintEnrollmentsLogsV2 (string id)

Download print enrollments logs V2

Download logs for print enrollments. Caller requires the issuance view permission to access this resource.

Example

Using the DownloadPrintEnrollmentsLogsV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe request ID

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected 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

Using the GetPrintEnrollmentsBulkOperationDetailsWithHttpInfo 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<BulkPrintOperationDetails>

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

GetPrintRequestDetails

PrintRequestDetails GetPrintRequestDetails (string id)

Get print request details

Get print request details. Caller requires the issuance view permission to access this resource.

Example

Using the GetPrintRequestDetailsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe print request id

Return type

PrintRequestDetails

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
403Forbidden-
404The specified resource was not found-
409Conflict-
500Unexpected error-

PrintEnrollmentsBulkOperation

BulkPrintOperationDetails PrintEnrollmentsBulkOperation (EnrollmentMultiPrintApiRequestV1 enrollmentMultiPrintApiRequestV1)

Create bulk print enrollment request

Create bulk print enrollment request. Caller requires the issuance add permission to access this resource.

Example

Using the PrintEnrollmentsBulkOperationWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
enrollmentMultiPrintApiRequestV1EnrollmentMultiPrintApiRequestV1

Return type

BulkPrintOperationDetails

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

PrintEnrollmentsBulkOperationV2

BulkPrintOperationDetails PrintEnrollmentsBulkOperationV2 (EnrollmentMultiPrintApiRequestV2 enrollmentMultiPrintApiRequestV2)

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

Using the PrintEnrollmentsBulkOperationV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
enrollmentMultiPrintApiRequestV2EnrollmentMultiPrintApiRequestV2

Return type

BulkPrintOperationDetails

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

SingleEnrollmentPrint

EnrollmentPrintApiResponse SingleEnrollmentPrint (EnrollmentPrintApiRequestV1 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

Using the SingleEnrollmentPrintWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
enrollmentPrintApiRequestV1EnrollmentPrintApiRequestV1

Return type

EnrollmentPrintApiResponse

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-