API Resources

Mobile Learner - Live Courses API

This endpoint controls the mobile live courses endpoints

Interfaces

List of the user's live courses with the corresponding enrollment

GET /api/mobile/learner/live_courses

Response Codes

  • 200 OK
  • 400 Bad Request

Parameters

  • live_course_ids Array Required

    An array of Integer live_course_ids to be fetched by this request.

Example Response

{
  "items": [
    {
      "enrollment": {
        "id": 2,
        "completed_at": null,
        "end_at": "2023-07-25T08:00:00.969Z",
        "required": true,
        "state": "registered",
        "registered": true,
        "multi_part": false,
        "registered_session_start_at": "2023-07-25T07:00:00.969Z",
        "registered_session_end_at": "2023-07-25T08:00:00.969Z",
        "registered_session_parts": []
      },
      "enrollment_profile": {
        "has_certificate": false,
        "open_enrollment": false,
        "uuid": "d7483698"
      },
      "template": {
        "id": 1,
        "description": null,
        "title": "lt1 - no multi part sessions",
        "cover_slide_data": {
          "background_image_url": null
        },
        "launch_url": "http://bridge.learn.local.bridgeops.sh/learner/calendar?liveCourseId=1"
      }
    }
  ]
}

LiveCourse template with the corresponding enrollment

GET /api/mobile/learner/live_courses/:id

Response Codes

  • 200 OK
  • 400 Bad Request

Example Request

/api/mobile/learner/live_courses/1

Example Response

{
  "enrollment": {
    "id": 2,
    "completed_at": null,
    "end_at": "2023-07-25T08:00:00.969Z",
    "required": true,
    "state": "registered",
    "registered": true,
    "multi_part": false,
    "registered_session_start_at": "2023-07-25T07:00:00.969Z",
    "registered_session_end_at": "2023-07-25T08:00:00.969Z",
    "registered_session_parts": []
  },
  "enrollment_profile": {
    "has_certificate": false,
    "open_enrollment": false,
    "uuid": "d7483698"
  },
  "type": "LiveCourse",
  "template": {
    "id": 1,
    "description": null,
    "title": "lt1 - no multi part sessions",
    "cover_slide_data": {
      "background_image_url": null
    },
    "launch_url": "http://bridge.learn.local.bridgeops.sh/learner/calendar?liveCourseId=1"
  }
}