engagementOrgsTimePerCourseRetrieveWithHttpInfo method

Future<Response> engagementOrgsTimePerCourseRetrieveWithHttpInfo(
  1. String org, {
  2. String? endDate,
  3. String? format,
  4. int? groupId,
  5. int? length,
  6. int? page,
  7. String? startDate,
})

Aggregated time spent value on a per course basis

Note: This method returns the HTTP Response.

Parameters:

  • String org (required):

  • String endDate: end date. ISO 8601

  • String format: Format * json - json

  • int groupId: Cohort Group ID

  • int length: Size of data to return

  • int page: Page offset

  • String startDate: start date. ISO 8601

Implementation

Future<Response> engagementOrgsTimePerCourseRetrieveWithHttpInfo(String org, { String? endDate, String? format, int? groupId, int? length, int? page, String? startDate, }) async {
  // ignore: prefer_const_declarations
  final path = r'/api/engagement/orgs/{org}/time/per-course'
    .replaceAll('{org}', org);

  // ignore: prefer_final_locals
  Object? postBody;

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

  if (endDate != null) {
    queryParams.addAll(_queryParams('', 'end_date', endDate));
  }
  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 (startDate != null) {
    queryParams.addAll(_queryParams('', 'start_date', startDate));
  }

  const contentTypes = <String>[];


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