Skip to main content

EnrollmentOperationsApi

MethodHTTP requestDescription
create_enrollmentsPOST /api/web/v1/enrollment/apiCreate enrollment records. Caller requires the ENROLLMENTS:ADD permission.
create_enrollments_v2POST /api/web/v2/enrollments/{enrollmentDesignName}Create Enrollments
delete_enrollmentsDELETE /api/web/v1/enrollment/apiDelete enrollment records. Caller requires the ENROLLMENTS:REMOVE permission.
delete_enrollments_v2DELETE /api/web/v2/enrollmentsDelete Enrollments
read_enrollment_v2GET /api/web/v2/enrollments/{id}Read Enrollment
read_enrollmentsPOST /api/web/v1/enrollment/api/readEnrollmentsRead enrollment records. Caller requires the ENROLLMENTS:VIEW permission.
read_enrollments_design_namesGET /api/web/v2/enrollments/enrollmentDesignsRead Enrollment designs name
read_enrollments_v2POST /api/web/v2/enrollments/read/{enrollmentDesignName}Read Enrollments
update_enrollmentsPUT /api/web/v1/enrollment/apiUpdate enrollment records. Caller requires the ENROLLMENTS:EDIT permission.
update_enrollments_v2PUT /api/web/v2/enrollmentsUpdate Enrollments

create_enrollments​

EnrollmentApiPayload create_enrollments(enrollment_api_payload)

Create enrollment records. Caller requires the ENROLLMENTS:ADD permission.

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_api_payloadEnrollmentApiPayload

Return type​

EnrollmentApiPayload

Authorization​

AdminAPIAuthentication

HTTP request headers​

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

HTTP response details​

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

create_enrollments_v2​

List[EnrollmentResponse] create_enrollments_v2(enrollment_design_name, enrollment_request)

Create Enrollments

Create one or more enrollments. Caller requires the ENROLLMENTS:ADD permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_design_namestrName of the enrollment design
enrollment_requestList[EnrollmentRequest]

Return type​

List[EnrollmentResponse]

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-

delete_enrollments​

str delete_enrollments(enrollment_api_payload)

Delete enrollment records. Caller requires the ENROLLMENTS:REMOVE permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_api_payloadEnrollmentApiPayload

Return type​

str

Authorization​

AdminAPIAuthentication

HTTP request headers​

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

HTTP response details​

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

delete_enrollments_v2​

List[EnrollmentResponse] delete_enrollments_v2(enrollment_delete)

Delete Enrollments

Delete one or more enrollments. Caller requires the ENROLLMENTS:DELETE permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_deleteEnrollmentDelete

Return type​

List[EnrollmentResponse]

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-

read_enrollment_v2​

EnrollmentResponse read_enrollment_v2(id)

Read Enrollment

Read an enrollment. Caller requires the ENROLLMENTS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrId of the enrollment (In Base64 string format)

Return type​

EnrollmentResponse

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-

read_enrollments​

EnrollmentApiPayload read_enrollments(read_enrollment_api_payload)

Read enrollment records. Caller requires the ENROLLMENTS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
read_enrollment_api_payloadReadEnrollmentApiPayload

Return type​

EnrollmentApiPayload

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-

read_enrollments_design_names​

List[EnrollmentDesignName] read_enrollments_design_names()

Read Enrollment designs name

Read enrollment designs name. Caller requires the ENROLLMENTS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

This endpoint does not need any parameter.

Return type​

List[EnrollmentDesignName]

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-

read_enrollments_v2​

List[EnrollmentResponse] read_enrollments_v2(enrollment_design_name, model_field, offset=offset, limit=limit)

Read Enrollments

Read one or more enrollments. Caller requires the ENROLLMENTS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_design_namestrName of the enrollment design
model_fieldList[ModelField]
offsetintPage number offset, default value is 1[optional] [default to 1]
limitintPage size limit, default value is 50[optional] [default to 50]

Return type​

List[EnrollmentResponse]

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-

update_enrollments​

str update_enrollments(enrollment_api_payload)

Update enrollment records. Caller requires the ENROLLMENTS:EDIT permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_api_payloadEnrollmentApiPayload

Return type​

str

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-

update_enrollments_v2​

List[EnrollmentResponse] update_enrollments_v2(enrollment_request)

Update Enrollments

Update one or more enrollments. Caller requires the ENROLLMENTS:EDIT permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_requestList[EnrollmentRequest]

Return type​

List[EnrollmentResponse]

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-