perlearnerOrgsUsersRetrieve method

Future<PerlearnerUserList?> perlearnerOrgsUsersRetrieve(
  1. String org, {
  2. String? format,
  3. int? groupId,
  4. int? length,
  5. int? page,
  6. String? search,
})

List of entire learners on the platform with aggregated enrollments, completions and time spent

Parameters:

  • String org (required):

  • String format: Format * json - json

  • int groupId: Cohort Group ID

  • int length: Size of data to return

  • int page: Page offset

  • String search: Search string for learner

Implementation

Future<PerlearnerUserList?> perlearnerOrgsUsersRetrieve(String org, { String? format, int? groupId, int? length, int? page, String? search, }) async {
  final response = await perlearnerOrgsUsersRetrieveWithHttpInfo(org,  format: format, groupId: groupId, length: length, page: page, search: search, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'PerlearnerUserList',) as PerlearnerUserList;

  }
  return null;
}