CourseDetailResponse

  • course
    Type: object · CourseSummaryRow
    required
    • completion_coverage
      Type: object · CoverageMetric
      required

      Completion across currently applicable stable course identities; completion on an earlier course version remains complete.

    • course_id
      Type: string · Course IdFormat: uuid
      required
    • course_slug
      Type: string · Course Slug
      required
    • course_title
      Type: string · Course Title
      required
    • enrollment_coverage
      Type: object · CoverageMetric
      required

      Coverage across the currently applicable learner population.

  • learners
    Type: array object[] · Learners
    required
    • academy_enabled
      Type: boolean · Academy Enabled
      required
    • can_manage_enrollments
      Type: boolean · Can Manage Enrollments
      required
    • course_id
      Type: string · Course IdFormat: uuid
      required
    • course_slug
      Type: string · Course Slug
      required
    • course_title
      Type: string · Course Title
      required
    • is_current_course
      Type: boolean · Is Current Course
      required
    • is_eligible_pair
      Type: boolean · Is Eligible Pair
      required
    • learner_id
      Type: string · Learner IdFormat: uuid
      required
    • learner_name
      Type: string · Learner Name
      required
    • progress_pct
      Type: integer · Progress Pct
      min:  
      0
      max:  
      100
      required

      Integer numbers.

    • status
      Type: string · Statusenum
      required
      values
      • not_enrolled
      • not_started
      • in_progress
      • completed
      • access_revoked
      • retired
    • tenant_id
      Type: string · Tenant IdFormat: uuid
      required
    • tenant_name
      Type: string · Tenant Name
      required
    • access_revoked_at
      Type: string · Access Revoked AtFormat: date-timenullable

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • completed_at
      Type: string · Completed AtFormat: date-timenullable

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • enrolled_at
      Type: string · Enrolled AtFormat: date-timenullable

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • enrollment_id
      Type: string · Enrollment IdFormat: uuidnullable
    • last_activity_at
      Type: string · Last Activity AtFormat: date-timenullable

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • learner_email
      Type: string · Learner Emailnullable
    • learner_external_id
      Type: string · Learner External Idnullable
  • status_counts
    Type: object · LearningStatusCounts
    required

    All reportable current and historical learner-course records.

    • access_revoked
      Type: integer · Access Revoked
      required

      Integer numbers.

    • completed
      Type: integer · Completed
      required

      Integer numbers.

    • in_progress
      Type: integer · In Progress
      required

      Integer numbers.

    • not_enrolled
      Type: integer · Not Enrolled
      required

      Integer numbers.

    • not_started
      Type: integer · Not Started
      required

      Integer numbers.

    • retired
      Type: integer · Retired
      required

      Integer numbers.

  • tenant
    Type: object · TenantContext
    required
    • academy_enabled
      Type: boolean · Academy Enabled
      required
    • can_manage_enrollments
      Type: boolean · Can Manage Enrollments
      required
    • tenant_id
      Type: string · Tenant IdFormat: uuid
      required
    • tenant_name
      Type: string · Tenant Name
      required
  • next_cursor
    Type: string · Next Cursornullable