API Resources

Mobile Learner - Courses API

This endpoint controls the mobile course endpoints

Interfaces

List of the user's course templates with the corresponding enrollment

GET /api/mobile/learner/courses

Response Codes

  • 200 OK
  • 400 Bad Request

Parameters

  • course_template_ids Array Required

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

Example Requests

with comma separated course_template_ids
/api/mobile/learner/courses?course_template_ids=1,2,3
with array course_template_ids
/api/mobile/learner/courses?course_template_ids[]=1&course_template_ids[]=2&course_template_ids[]=3

Example Response

{
  "items": [
    {
      "enrollment": null,
      "enrollment_profile": {
        "enroll_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/1afa4c6c/enroll",
        "has_certificate": false,
        "open_enrollment": true,
        "uuid": "1afa4c6c"
      },
      "template": {
        "id": 1,
        "course_type": "bridge",
        "description": null,
        "estimated_time": 1,
        "has_quizzes": false,
        "external_info": null,
        "title": "Course1",
        "cover_slide_data": {
          "background_image_url": "https://s3-us-east-2.amazonaws.com/bridge-learn-file-store-edge-cmh/1/1/uploads/ab6ea96d-05d5-46ac-b863-043d6acf990a.png"
        },
        "launch_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/1/launch"
      }
    },
    {
      "enrollment": {
        "id": 1,
        "completed_at": null,
        "end_at": "2023-07-25T05:59:59.999Z",
        "learning_item_id": 1,
        "required": true,
        "score": 0,
        "state": "active",
        "time_remaining": 1
      },
      "enrollment_profile": {
        "enroll_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/6f925e23/enroll",
        "has_certificate": false,
        "open_enrollment": false,
        "uuid": "6f925e23"
      },
      "template": {
        "id": 2,
        "course_type": "bridge",
        "description": null,
        "estimated_time": 1,
        "has_quizzes": false,
        "external_info": null,
        "title": "Course2",
        "launch_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/2/launch"
      }
    },
    {
      "enrollment": null,
      "enrollment_profile": {
        "enroll_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/68685524/enroll",
        "has_certificate": false,
        "open_enrollment": false,
        "uuid": "68685524"
      },
      "template": {
        "id": 3,
        "course_type": "scorm",
        "description": "",
        "estimated_time": null,
        "has_quizzes": false,
        "external_info": {
          "available_offline": false,
          "external_learning_standard": "SCORM_2004_3RD_EDITION",
          "external_version": 0
        },
        "title": "SCORM1 - RunTimeAdvancedCalls_SCORM20043rdEdition",
        "launch_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/3/mobile_scorm_launch"
      }
    }
  ]
}

Course template with the corresponding enrollment

GET /api/mobile/learner/courses/:id

Response Codes

  • 200 OK
  • 400 Bad Request

Example Request

/api/mobile/learner/courses/1

Example Response

{
  "enrollment": null,
  "enrollment_profile": {
    "enroll_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/1afa4c6c/enroll",
    "has_certificate": false,
    "open_enrollment": true,
    "uuid": "1afa4c6c"
  },
  "type": "CourseTemplate",
  "template": {
    "id": 1,
    "course_type": "bridge",
    "description": null,
    "estimated_time": 1,
    "has_quizzes": false,
    "external_info": null,
    "title": "Course1",
    "cover_slide_data": {
      "background_image_url": "https://s3-us-east-2.amazonaws.com/bridge-learn-file-store-edge-cmh/1/1/uploads/ab6ea96d-05d5-46ac-b863-043d6acf990a.png"
    },
    "launch_url": "http://bridge.learn.local.bridgeops.sh/learner/courses/1/launch"
  }
}