Course Completion Criteria

Returns the completion criteria configured for a course. Each criterion defines a condition a learner must satisfy for the course to be marked complete

Returns the completion criteria configured for a course. Each criterion defines a condition a learner must satisfy for the course to be marked complete.

GEThttps://example.thoughtindustries.com/incoming/v2/courses/:courseId/completionCriteria

Example request

curl "https://example.thoughtindustries.com/incoming/v2/courses/:courseId/completionCriteria" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`courseId`	`uuid`	Yes	path	The courseId identifier.

Example response

{
  "data": {
    "APICourseCompletionCriteria": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "course": "00000000-0000-0000-0000-000000000000",
        "type": "coursePercentViewed",
        "description": "string",
        "coursePercentViewed": 0,
        "courseAssignmentComplete": "00000000-0000-0000-0000-000000000000",
        "bongoAssignmentCompleted": "00000000-0000-0000-0000-000000000000",
        "courseAssessmentPassed": "00000000-0000-0000-0000-000000000000",
        "courseTopicViewed": "00000000-0000-0000-0000-000000000000",
        "courseMeetingAttended": "00000000-0000-0000-0000-000000000000",
        "scormComplete": "00000000-0000-0000-0000-000000000000",
        "surveyGizmoComplete": "00000000-0000-0000-0000-000000000000",
        "xApiComplete": "00000000-0000-0000-0000-000000000000",
        "articlePercentViewed": 0,
        "articleTimeViewedInSeconds": 0,
        "videoPercentViewed": 0,
        "videoTopicId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

Response fields

Field	Type	Description
`[].id`	`uuid`	Unique identifier for this completion criterion.
`[].course`	`uuid`	ID of the course this criterion belongs to.
`[].type`	`CourseCompletionCriteriaType`	Discriminator that identifies which criterion type applies (e.g. `coursePercentViewed`).
`[].description`	`string`	Human-readable label describing this criterion.
`[].coursePercentViewed`	`integer`	Minimum percentage of the course a learner must view to satisfy this criterion, expressed as a whole number.
`[].courseAssignmentComplete`	`uuid`	ID of the course assignment that must be completed to satisfy this criterion.
`[].bongoAssignmentCompleted`	`uuid`	ID of the Bongo assignment that must be completed to satisfy this criterion.
`[].courseAssessmentPassed`	`uuid`	ID of the course assessment that must be passed to satisfy this criterion.
`[].courseTopicViewed`	`uuid`	ID of the course topic that must be viewed to satisfy this criterion.
`[].courseMeetingAttended`	`uuid`	ID of the course meeting that must be attended to satisfy this criterion.
`[].scormComplete`	`uuid`	ID of the SCORM topic that must be completed to satisfy this criterion.
`[].surveyGizmoComplete`	`uuid`	ID of the SurveyGizmo survey that must be completed to satisfy this criterion.
`[].xApiComplete`	`uuid`	ID of the xAPI activity that must be completed to satisfy this criterion.
`[].articlePercentViewed`	`integer`	Minimum percentage of a specific article a learner must view, expressed as a whole number.
`[].articleTimeViewedInSeconds`	`integer`	Minimum time a learner must spend viewing an article to satisfy this criterion, in seconds.
`[].videoPercentViewed`	`integer`	Minimum percentage of a specific video a learner must watch, expressed as a whole number.
`[].videoTopicId`	`uuid`	ID of the video topic to which the `videoPercentViewed` criterion applies.