audienceOrgsRegisteredUsersPerCourseRetrieveWithHttpInfo method
Aggregated count of active/inactive enrollments on a per course basis Query Params active e.g true/false would mean not active enrollments
Note: This method returns the HTTP Response.
Parameters:
-
String org (required):
-
String active: Any of
y,yes,true. set to false or no for unenrollments *y- y *yes- yes *true- true *True- True *n- n *no- no *false- false *False- False -
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> audienceOrgsRegisteredUsersPerCourseRetrieveWithHttpInfo(String org, { String? active, String? endDate, String? format, int? groupId, int? length, int? page, String? startDate, }) async {
// ignore: prefer_const_declarations
final path = r'/api/audience/orgs/{org}/registered-users/per-course'
.replaceAll('{org}', org);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (active != null) {
queryParams.addAll(_queryParams('', 'active', active));
}
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,
);
}