API Resources

Learner - Programs API

This API controls learner interaction with programs.

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 program

GET /api/learner/programs/:id

Response Codes

  • 200 OK

Parameters

  • id Integer Required

    Path parameter. A program id.

Example Response

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