perlearnerOrgsUsersRetrieveWithHttpInfo method

Future<Response> perlearnerOrgsUsersRetrieveWithHttpInfo(
  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

Note: This method returns the HTTP Response.

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<Response> perlearnerOrgsUsersRetrieveWithHttpInfo(String org, { String? format, int? groupId, int? length, int? page, String? search, }) async {
  // ignore: prefer_const_declarations
  final path = r'/api/perlearner/orgs/{org}/users'
    .replaceAll('{org}', org);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (format != null) {
    queryParams.addAll(_queryParams('', 'format', format));
  }
  if (groupId != null) {
    queryParams.addAll(_queryParams('', 'group_id', groupId));
  }
  if (length != null) {
    queryParams.addAll(_queryParams('', 'length', length));
  }
  if (page != null) {
    queryParams.addAll(_queryParams('', 'page', page));
  }
  if (search != null) {
    queryParams.addAll(_queryParams('', 'search', search));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}