API Resources

Learner - Open Programs API

Interfaces

Object Synopses

LearnerProgramResponse

  • id String

    The program id

  • title String

    The title of the program.

  • description String

    The description of the program.

  • program_items_count Integer

    Total number of program items.

  • completed_program_items_count Integer

    Total number of completed program items.

  • time_remaining Integer

    Estimated time to finish the program in minutes.

Show a program with open enrollment enabled using a UUID

GET /api/learner/open_programs/:id

Response Codes

  • 200 OK
  • 404 Not Found

Parameters

  • id String Required

    Path parameter. An open program uuid.

Example Response

{
  "programs": [
    "{API::LearnerProgramResponse}"
  ],
  "meta": {}
}