Retrieve Course

API Documentation

Retrieve Course

The Get Course API retrieves course information for the targeted ID.

Endpoint:

Get /
/api/v1/Course/{CourseId}

Request Parameters

Id Int (Required)

The Id of the course to retrieve.

Response

Id Int(Not Nullable)

The Id of the course.

ExternalId String(Nullable)

The course’s external ID, usually a unique identifier from the calling system

AvailableInstructorLed Boolean(Not Nullable)

The setting for if this course is available to be delivered in an instructor-led format

Name String(Not Nullable)

Name of the course.

AvailableSelfPaced Boolean(Not Nullable)

The setting for if this course is available to be delivered in a self-paced format

OrganizationId Int(Nullable)

The Id of the owning organization for this course

OrganizationName String(Nullable)

The name of the owning organization for this course

ContentProviderId Int(Nullable)

The Id of the content provider for this course (if any)

ContentProviderName Int(Nullable)

The name of the content provider for this course (if any)

Activities Array of CourseActivity (Not Nullable)

A nested list of the actvities for the course (See CourseActivity type below)

Tags Array of CourseTag (Not Nullable)

A list of the tags associated with the course (See Tag type below

				
					{
  "Course": {
    "Id": 98765,
    "ExternalId": null,
    "Name": "A Course Name",
    "AvailableInstructorLed": false,
    "AvailableSelfPaced": true,
    "ContentProviderId": 124,
    "ContentProviderName": "Some Content Provider",
    "OrganizationId": 6543,
    "OrganizationName": "An Organization",
    "Activites": [
      {
        "Id": 23456,
        "ActivityTypeId": 4,
        "ActivityTypeName": "Lab",
        "ParentId": null,
        "Activities": [],
        "Subtitle": "",
        "Description": "An Activity Description",
        "Name": "An Activity name",
        "AllowRetake": true,
        "AllowReview": false,
        "Url": null,
        "SortOrder": 0,
        "Required": true,
        "AvailabilityTypeId": 0,
        "ExpectedDurationSeconds": 3540,
        "IsExam": false
      },
      {
        "Id": 34567,
        "ActivityTypeId": 80,
        "ActivityTypeName": "Section",
        "ParentId": null,
        "Activities": [
          {
            "Id": 45678,
            "ActivityTypeId": 60,
            "ActivityTypeName": "Video",
            "ParentId": 34567,
            "Activities": [],
            "Subtitle": null,
            "Description": "",
            "Name": "Example Video",
            "AllowRetake": false,
            "AllowReview": false,
            "Url": "https://video.url/video/4",
            "SortOrder": 0,
            "Required": false,
            "AvailabilityTypeId": 0,
            "ExpectedDurationSeconds": 298,
            "IsExam": false
          },
          {
            "Id": 56789,
            "ActivityTypeId": 70,
            "ActivityTypeName": "Document",
            "ParentId": 34567,
            "Activities": [],
            "Subtitle": null,
            "Description": "",
            "Name": "Some Document",
            "AllowRetake": false,
            "AllowReview": false,
            "Url": "https://document.url/document/3",
            "SortOrder": 1,
            "Required": false,
            "AvailabilityTypeId": 0,
            "ExpectedDurationSeconds": 0,
            "IsExam": false
          }
        ],
        "Subtitle": null,
        "Description": "",
        "Name": "Some Section",
        "AllowRetake": false,
        "AllowReview": false,
        "Url": "https://video.url/video/4",
        "SortOrder": 1,
        "Required": false,
        "AvailabilityTypeId": 0,
        "ExpectedDurationSeconds": 0,
        "IsExam": false
      },
      {
        "Id": 67890,
        "ActivityTypeId": 60,
        "ActivityTypeName": "Video",
        "ParentId": null,
        "Activities": [],
        "Subtitle": null,
        "Description": "A short description of Final Video",
        "Name": "Final Video",
        "AllowRetake": false,
        "AllowReview": false,
        "Url": "https://video.url/video/18",
        "SortOrder": 2,
        "Required": false,
        "AvailabilityTypeId": 0,
        "ExpectedDurationSeconds": 0,
        "IsExam": false
      }
    ],
    "Tags": [
      {
        "Id": 123,
        "Name": "Tag 123"
      },
      {
        "Id": 456,
        "Name": "Tag 456"
      },
      {
        "Id": 789,
        "Name": "Tag 789"
      },
      {
        "Id": 101,
        "Name": "Tag 101"
      },
      {
        "Id": 112,
        "Name": "Tag 112"
      },
      {
        "Id": 131,
        "Name": "Tag 131"
      }
    ],
    "CustomFields": [
      {
        "Name": "MyCustomText",
        "TextValue": "Success!"
      },
      {
        "Name": "MyCustomNumber",
        "TextValue": "3"
      }
    ]
  }
}

Objects

CourseActivity

PropertyTypeNullableNote
IdIntNot Nullable

The activity’s unique identifier

ParentIdIntNullable

The Id of the activity’s parent activity (if any)

ActivityTypeIdIntNot Nullable

The Id of the activity type

ScormModule = 2

AiccModule = 3

Lab = 4

Survey = 10

InstructorSurvey = 20

OrganizationSurvey = 30

ExternalLink = 40

Assessment = 50

Video = 60

Document = 70

Section = 80

ActivityIdIntNot Nullable

The internal Id of the activity.

ActivityTypeNameStringNot Nullable

The activity’s type name

NameStringNot Nullable

The activity’s name

DescriptionStringNullable

The activity’s description

SubtitleStringNullable

The activity’s subtitle

AllowRetakeBooleanNot Nullable

The activity’s setting to allow retakes

AllowReviewBooleanNot Nullable

The activity’s setting to allow review

UrlStringNullable

The activity’s url

SortOrderIntNot Nullable

The activity’s sort order index

RequiredBooleanNot Nullable

The activity’s setting for if the activity is required for course completion

AvailabilityTypeIdIntNot Nullable

The activity’s availablility type id

Everyone = 0

Instructors Only = 1

ExpectedDurationSecondsIntNot Nullable

The activity’s expected duration in seconds

IsExamBooleanNot Nullable

The activity’s setting as an exam (This only applies to Lab type activities)

ActivitiesArray of CourseActivityNot Nullable

A nested list of the actvities for the course (See CourseActivity type)

Tag

PropertyTypeNullableNote
IdIntNot Nullable

The tag’s unique identifier

NameStringNot Nullable

The tag’s name