API Resources

Author - Program Enrollments API

Enables fetching, creating, and deleting enrollments (learners) for a program

Interfaces

Object Synopses

ProgramEnrollmentResponse

  • id Integer

    User id of learner

  • name String

    Name of learner

  • email String

    Email of learner

  • avatar_url String

    URL to avatar image

  • state String

    Current state of enrollment. One of ‘active’ or ‘complete’

  • enrollment_id Integer

    Enrollment id

  • current_program_item_index Integer

    Current program item step learner is on

  • total_program_items Integer

    Total number of steps in program

  • current_program_item_due Integer

    Number of days until current course is due

  • pending_approval_item_count Integer

    Number of program items pending approval

  • program_due Integer

    Number of days until program is due

  • group_ids String[]

    Group ids associated with this learner’s enrollment

  • created_at String

    Time when this program enrollment was created.

  • updated_at String

    Time when this program enrollment was last updated.

  • deleted_at String

    Time when this program enrollment was deleted. Only present if deleted records were requested.

  • end_at DateTime

    Due date for this program enrollment

  • expires_at DateTime

    Expiration date for this program enrollment

  • completed_at DateTime

    Completion date for this program enrollment

Fetch list of enrollments (learners) in a program

GET /api/author/programs/:program_id/learners

Response Codes

  • 200 OK

Parameters

  • program_id Integer Required

    Path parameter. Program id for the learners we want

  • updated_after DateTime

    Query parameter. Filters list to only include learners updated after the given RFC 3339 compliant timestamp.

  • created_after DateTime

    Query parameter. Filters list to only include learners created after the given RFC 3339 compliant timestamp.

  • deleted_after DateTime

    Query parameter. Filters list to only include learners deleted after the given RFC 3339 compliant timestamp.

  • updated_before DateTime

    Query parameter. Filters list to only include learners updated before the given RFC 3339 compliant timestamp.

  • created_before DateTime

    Query parameter. Filters list to only include learners created before the given RFC 3339 compliant timestamp.

  • deleted_before DateTime

    Query parameter. Filters list to only include learners deleted before the given RFC 3339 compliant timestamp.

  • only_deleted Boolean

    Filters list to only include deleted learners.

  • with_deleted Boolean

    Filters list to also include deleted learners.

  • sort String [ name, progress, course_due_date, due_date, renew_date ]

    Query parameter causes list to be returned in ascending order. Values may be prepended with - for descending order.

  • search String

    Find enrollments with learner matching values in first name, last name, uid, or email.

  • user_id Integer

    Find enrollments belonging to a specific learner.

Example Response

{
  "meta": {
    "next": "http://bridge.bridgeapp.com/api/author/programs/1/learners?after=eyJ0eXAiOiJKV1QiLCJhSDiQQ"
  },
  "enrollments": [
    "{API::ProgramEnrollmentResponse}"
  ]
}

Enroll learner into program

POST /api/author/programs/:program_id/learners

No documentation available yet.

Update program enrollment

PATCH /api/author/programs/:program_id/learners/:id
PUT /api/author/programs/:program_id/learners/:id

Response Codes

  • 200 OK

Parameters

  • program_id Integer Required

    Path parameter. Program id for the learners we want

  • program_enrollment_id Integer Required

    Path parameter. Program enrollment id for the learner

  • payload JSON Required

    Request body. Must include an ‘enrollments’ field with updated data.

Example Request

JSON cURL 
{
  "enrollments": [
    {
      "end_at": "2017-12-31 07:00:00",
      "expires_at": "2018-12-31 07:00:00"
    }
  ]
}
curl \
  -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"enrollments":[{"end_at":"2017-12-31 07:00:00","expires_at":"2018-12-31 07:00:00"}]}' \
  http://<bridge>/api/author/programs/:program_id/learners/:id

Example Response

{
  "meta": {},
  "enrollments": [
    "{API::ProgramEnrollmentResponse}"
  ]
}

Remove learner from program

DELETE /api/author/programs/:program_id/learners/:id

No documentation available yet.