API Resources

Author - Checkpoint Enrollments API

Enables fetching, updating, and resetting enrollments (learners) for a task

Interfaces

Object Synopses

CheckpointEnrollmentResponse

  • id Integer

    Id of enrollment

  • user_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 ‘assigned’ or ‘complete’

  • has_custom_approver Boolean

    Whether this checkpoint enrollment has custom approver set.

  • sources Array

    Lists the sources of the enrollment whether individual user enrollment, group enrollment, etc.

  • approval ApprovalResponse

    The approval linked to this checkpoint enrollment. Only there if the checkpoint requires approval.

  • foreseen_approver ApproverResponse

    If the linked approval exists and is in the ‘incomplete’ state, it represents who the approver will be when the learner requests approval.

  • default_approver ApproverResponse

    If the linked approval exists, it represents the default approver.

  • created_at String

    Time when this checkpoint enrollment was created.

  • updated_at String

    Time when this checkpoint enrollment was last updated.

  • deleted_at String

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

  • end_at DateTime

    Due date for this checkpoint enrollment

  • completed_at DateTime

    Completion date for this checkpoint enrollment

  • allow_re_enroll Boolean

    Can the learner be re-enrolled with this checkpoint enrollment.

Fetch list of enrollments (learners) in a checkpoint

GET /api/author/tasks/:task_id/learners

Response Codes

  • 200 OK
  • 404 Not Found

Parameters

  • task_id Integer Required

    Path parameter. Checkpoint 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.

  • includes[] String [ approval_events ]

    Query paramater. Additional information to be returned in the response. If approval_events is given, response will include any approval events in any linked approvals.

  • sort String [ name, end_at, approver, status ]

    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/tasks/1/learners?after=eyJ0eXAiOiJKV1QiLCJhSDiQQ"
  },
  "enrollments": [
    "{API::CheckpointEnrollmentResponse}"
  ]
}

Update checkpoint enrollment

PATCH /api/author/tasks/:task_id/learners/:id
PUT /api/author/tasks/:task_id/learners/:id

Response Codes

  • 200 OK
  • 404 Not Found

Parameters

  • checkpoint_id Integer Required

    Path parameter. Checkpoint id for the learners we want

  • checkpoint_enrollment_id Integer Required

    Path parameter. Checkpoint enrollment id for the learner

  • payload JSON Required
    No description provided.

Example Request

/api/author/tasks/1/learners/1

Example Response

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