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 enrollmentApiPayload)
Create enrollment records. Caller requires the ENROLLMENTS:ADD permission.
Using the CreateEnrollmentsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string enrollmentDesignName, List<EnrollmentRequest> enrollmentRequest)
Create Enrollments
Create one or more enrollments. Caller requires the ENROLLMENTS:ADD permission.
Example
Using the CreateEnrollmentsV2WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 enrollmentApiPayload)
Delete enrollment records. Caller requires the ENROLLMENTS:REMOVE permission.
Example
Using the DeleteEnrollmentsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 enrollmentDelete)
Delete Enrollments
Delete one or more enrollments. Caller requires the ENROLLMENTS:DELETE permission.
Example
Using the DeleteEnrollmentsV2WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string id)
Read Enrollment
Read an enrollment. Caller requires the ENROLLMENTS:VIEW permission.
Example
Using the ReadEnrollmentV2WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 readEnrollmentApiPayload)
Read enrollment records. Caller requires the ENROLLMENTS:VIEW permission.
Example
Using the ReadEnrollmentsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
Using the ReadEnrollmentsDesignNamesWithHttpInfo 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
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 (string enrollmentDesignName, List<Field> field, int? offset = null, int? limit = null)
Read Enrollments
Read one or more enrollments. Caller requires the ENROLLMENTS:VIEW permission.
Example
Using the ReadEnrollmentsV2WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enrollmentDesignName | string | Name of the enrollment design | |
| field | List<Field> | ||
| offset | int? | Page number offset, default value is 1 | [optional] [default to 1] |
| limit | int? | 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 enrollmentApiPayload)
Update enrollment records. Caller requires the ENROLLMENTS:EDIT permission.
Example
Using the UpdateEnrollmentsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (List<EnrollmentRequest> enrollmentRequest)
Update Enrollments
Update one or more enrollments. Caller requires the ENROLLMENTS:EDIT permission.
Example
Using the UpdateEnrollmentsV2WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 | - |