API Resources

Author - Live Courses API

This API allows authors to list, display, create, update, and delete live courses.

Interfaces

Object Synopses

LiveCourseRequest

  • title String

    Title of live course.

  • description String

    A description of the live course.

  • external_course_id String

    An external identifier for the course.

  • has_certificate Boolean

    Indicates if a certificate is issued when course is successfully completed.

LiveCourseResponse

Live Course

  • id String Required
    No description provided.
  • title String Required
    No description provided.
  • author_id String Required

    The id of the creator of this live course.

  • created_at DateTime Required

    The timestamp at which this course was created

  • updated_at DateTime Required

    The timestamp at which this course was last changed

  • deleted_at DateTime

    The timestamp at which this course was deleted. Only present if deleted records were requested

  • description String Required

    A longer description of course content.

  • sessions_count Integer Required
    No description provided.
  • enrollments_count Integer Required
    No description provided.
  • is_published Boolean Required
    No description provided.
  • external_course_id String

    An external identifier for the course.

  • has_certificate Boolean

    Indicates if certificate is issued when course is successfully completed.

  • expires Boolean

    Indicates if this live course expires and must be retaken periodically. Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=expiration query parameter is passed.

  • default_days_until_expiration Integer

    Period of time until learner must be re-enrolled. Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=expiration query parameter is passed.

  • auto_re_enroll Boolean

    Indicates if Bridge will re-enroll the learner automatically after expiration. Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=expiration query parameter is passed.

  • re_enrollment_period Integer

    Number of days before expiration when Bridge will automatically re-enroll. Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=expiration query parameter is passed.

  • open_enrollment Boolean

    Indicates if enrollment is open to all users with enroll_url. Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=enrollment_profiles query parameter is passed.

  • uuid String

    Course uuid. Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=enrollment_profiles query parameter is passed.

  • enroll_url String

    URL a learner can use to enroll if open enrollment is permitted. Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=enrollment_profiles query parameter is passed.

  • enrollments {API::LiveCourseEnrollment}[]

    Array containing all enrollments for this live course. Omitted unless includes[]=enrollments query parameter is passed.

  • enrollment_counts {API::LiveCourseEnrollmentsCount}

    Always shown in ‘Show live course’ and ‘Update live course’ methods. Shown in ‘List live courses’ method if includes[]=counts query parameter is passed.

  • tags Array

    A list of tags for the live course

  • matching_tags Array

    Tags matching the search query for the live course

LiveCourseEnrollmentsCount

Detailed counts of enrollments

  • all Integer Required

    Total count of enrollments.

  • invited Integer Required

    Count of enrollments that have received invitations to register.

  • not_registered Integer Required

    Count of enrollments that have not registered for a session.

  • registered Integer Required

    Count of enrollments that have registered for a session.

  • finished Integer Required

    Count of enrollments that have completed a session.

List live courses

GET /api/author/live_courses

Response Codes

  • 200 OK
  • 304 Not Modified

@argument[Optional, String] search Query parameter. String to search for in title.

@argument[Optional, String] subaccounts[] Query parameter. Array of String subaccount IDs to filter by.

Parameters

  • sort String [ title, updated ]

    Query parameter. Applies a sort to the result list.

  • filters String [ upcoming ]

    Query parameter. Array of filters to limit results.

  • updated_after DateTime

    Filters list to only include records updated after the given RFC 3339 compliant timestamp.

  • created_after DateTime

    Filters list to only include records created after the given RFC 3339 compliant timestamp.

  • deleted_after DateTime

    Filters list to only include records deleted after the given RFC 3339 compliant timestamp.

  • updated_before DateTime

    Filters list to only include records updated before the given RFC 3339 compliant timestamp.

  • created_before DateTime

    Filters list to only include records created before the given RFC 3339 compliant timestamp.

  • deleted_before DateTime

    Filters list to only include records deleted before the given RFC 3339 compliant timestamp.

  • only_deleted Boolean

    Filters list to only include deleted live courses.

  • with_deleted Boolean

    Filters list to also include deleted live courses.

  • includes[] String [ counts, expiration, enrollments, enrollment_profiles ]

    Query paramater. Additional information to be returned in the response. This argument may occur multiple times. If counts is given, response will include enrollment_counts. If expiration is given, response will include auto_re_enroll, default_days_until_expiration, expires, and re_enrollment_period. If enrollment_profiles is given, response will include enroll_url, open_enrollment, and uuid. If enrollments is given, response will contain all enrollments and their registrations in the course.

Example Response

{
  "meta": {},
  "live_courses": [
    "{LiveCourseResponse}"
  ]
}

Create live course

POST /api/author/live_courses

Response Codes

  • 201 Created

Parameters

  • live_courses LiveCourseRequest[] Required

    Path parameter. An array of LiveCourseRequest. If Optional fields` are present, the new live course will be initialized with their values.

Example Request

JSON cURL 
{
  "live_courses": [
    "{API::LiveCourseRequest}"
  ]
}
curl \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"live_courses":["{API::LiveCourseRequest}"]}' \
  http://<bridge>/api/author/live_courses

Example Response

{
  "meta": {},
  "live_courses": [
    "{API::LiveCourseResponse}"
  ]
}

Show live course

GET /api/author/live_courses/:id

Response Codes

  • 200 OK
  • 304 Not Modified

Parameters

  • id Integer Required

    Path parameter. Live course id

  • includes[] String [ enrollments ]

    Query paramater. Additional information to be returned in the response. This argument may occur multiple times. If enrollments is given, response will contain all enrollments and their registrations in the course.

Example Response

{
  "meta": {},
  "live_courses": [
    "{API::LiveCourseResponse}"
  ]
}

Update live course

PATCH /api/author/live_courses/:id
PUT /api/author/live_courses/:id

Response Codes

  • 200 OK

Parameters

  • id Integer Required

    Path parameter. Live course id

  • title String Required

    Body parameter. The new live course title

  • description String Required

    Body parameter. The new live course description

Example Request

"{API::LiveCourseRequest}"

Example Response

{
  "meta": {},
  "live_courses": [
    "{API::LiveCourseResponse}"
  ]
}

Delete live course

DELETE /api/author/live_courses/:id

Response Codes

  • 204 No Content

Parameters

  • id Integer Required

    Path parameter. Live course id