API Resources

Learner - Program Items API

This API controls learner interactions with program items.

Interfaces

Object Synopses

LearnerProgramItemResponse

  • id String

    The unique ID of the program item.

  • index String

    The index of the program item.

  • learnable_id String

    The ID of the course template associated with the program item.

  • course_type String

    The type of Bridge course.

  • description String

    The description of the program item.

  • estimated_time Integer

    Estimated time to finish the program item.

  • has_certificate Boolean

    Does this program item have a certificate?

  • passing_threshold Integer

    The passing score for the program item

  • slide_total Integer

    The number of published slides for the program item

  • third_party_course_id String

    The external ID of a course.

  • title String

    The title of the program item.

  • completed_at DateTime or null

    DateTime that the item was completed.

  • deleted_at DateTime or null

    DateTime that the item was deleted.

  • end_at DateTime or null

    DateTime that the item was due.

  • expires_at DateTime or null

    DateTime that the item completion expires.

  • is_enrolled Boolean

    Is the learner enrolled in this item?

  • progress Float

    Progress of item finished.

  • renew_by DateTime or null

    DateTime by which the item must be re-enrolled.

  • score Integer or null

    Learners score (out of 100) in this item. Null for live trainings.

  • state String or null

    The state of the learner’s enrollment in the program item.

  • time_remaining Integer

    Estimated time to finish the item in minutes.

List program items

GET /api/learner/programs/:program_id/items

Response Codes

  • 200 OK

Parameters

  • program_id Integer Required

    Path parameter. A program id.

Example Response

{
  "program_items": [
    "{API::LearnerProgramItemResponse}"
  ]
}