EnrollmentOperationsApi
| Method | HTTP request | Description |
|---|---|---|
| createEnrollments | POST /api/web/v1/enrollment/api | Create enrollment records. Caller requires the ENROLLMENTS:ADD permission. |
| createEnrollmentsV2 | POST /api/web/v2/enrollments/{enrollmentDesignName} | Create Enrollments |
| deleteEnrollments | DELETE /api/web/v1/enrollment/api | Delete enrollment records. Caller requires the ENROLLMENTS:REMOVE permission. |
| deleteEnrollmentsV2 | DELETE /api/web/v2/enrollments | Delete Enrollments |
| readEnrollmentV2 | GET /api/web/v2/enrollments/{id} | Read Enrollment |
| readEnrollments | POST /api/web/v1/enrollment/api/readEnrollments | Read enrollment records. Caller requires the ENROLLMENTS:VIEW permission. |
| readEnrollmentsDesignNames | GET /api/web/v2/enrollments/enrollmentDesigns | Read Enrollment designs name |
| readEnrollmentsV2 | POST /api/web/v2/enrollments/read/{enrollmentDesignName} | Read Enrollments |
| updateEnrollments | PUT /api/web/v1/enrollment/api | Update enrollment records. Caller requires the ENROLLMENTS:EDIT permission. |
| updateEnrollmentsV2 | PUT /api/web/v2/enrollments | Update Enrollments |
createEnrollments
EnrollmentApiPayload createEnrollments(enrollmentApiPayload)
Create enrollment records. Caller requires the ENROLLMENTS:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentApiPayload | EnrollmentApiPayload |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
createEnrollmentsV2
List<EnrollmentResponse> createEnrollmentsV2(enrollmentDesignName, enrollmentRequest)
Create Enrollments
Create one or more enrollments. Caller requires the ENROLLMENTS:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentDesignName | String | Name of the enrollment design | |
| enrollmentRequest | List<EnrollmentRequest> |
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 | - |
deleteEnrollments
String deleteEnrollments(enrollmentApiPayload)
Delete enrollment records. Caller requires the ENROLLMENTS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentApiPayload | EnrollmentApiPayload |
Return type
String
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
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 | - |
deleteEnrollmentsV2
List<EnrollmentResponse> deleteEnrollmentsV2(enrollmentDelete)
Delete Enrollments
Delete one or more enrollments. Caller requires the ENROLLMENTS:DELETE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentDelete | EnrollmentDelete |
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 | - |
readEnrollmentV2
EnrollmentResponse readEnrollmentV2(id)
Read Enrollment
Read an enrollment. Caller requires the ENROLLMENTS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Id of the enrollment (In Base64 string format) |
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 | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
readEnrollments
EnrollmentApiPayload readEnrollments(readEnrollmentApiPayload)
Read enrollment records. Caller requires the ENROLLMENTS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| readEnrollmentApiPayload | ReadEnrollmentApiPayload |
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 | - |
readEnrollmentsDesignNames
List<EnrollmentDesignName> readEnrollmentsDesignNames()
Read Enrollment designs name
Read enrollment designs name. Caller requires the ENROLLMENTS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
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 | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
readEnrollmentsV2
List<EnrollmentResponse> readEnrollmentsV2(enrollmentDesignName, field, offset, limit)
Read Enrollments
Read one or more enrollments. Caller requires the ENROLLMENTS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentDesignName | String | Name of the enrollment design | |
| field | List<Field> | ||
| offset | Integer | Page number offset, default value is 1 | [optional] [default to 1] |
| limit | Integer | Page size limit, default value is 50 | [optional] [default to 50] |
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 | - |
updateEnrollments
String updateEnrollments(enrollmentApiPayload)
Update enrollment records. Caller requires the ENROLLMENTS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentApiPayload | EnrollmentApiPayload |
Return type
String
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 | - |
updateEnrollmentsV2
List<EnrollmentResponse> updateEnrollmentsV2(enrollmentRequest)
Update Enrollments
Update one or more enrollments. Caller requires the ENROLLMENTS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentRequest | List<EnrollmentRequest> |
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 | - |