Retrieve information about a course by id
- 16 Jul 2024
- 2 Minutes to read
- Print
Retrieve information about a course by id
- Updated on 16 Jul 2024
- 2 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/GetCourse/{id}
Allows you to get information about a course.
Security
API Key
Header parameter nameapi_key
Path parameters
id
integer (int32) Required
The ID of the course to retrieve
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
Course
object (Course)
Id
integer (int32)
The course's unique identifier
Example5678
ExternalId
string | null
The course's external ID, usually a unique identifier from the calling system
Examplece2637fc-7eac-43d1-9e75-565e9f7ff53b
Name
string
The Name of the course
ExampleA Course Name
Description
string | null
The description of the course
ExampleA course description
HtmlDescription
string | null
The HTML description of the course
Example<p>Some HTML Description</p>
AvailableInstructorLed
boolean
The setting for if this course is available to be delivered in an instructor-led format
ExampleTrue
AvailableSelfPaced
boolean
The setting for if this course is available to be delivered in a self-paced format
ExampleTrue
OrganizationId
integer (int32) | null
The Id of the owning organization for this course
Example345
OrganizationName
string | null
The name of the owning organization for this course
ExampleOrganization Name Sample
ContentProviderId
integer (int32) | null
The Id of the content provider for this course (if any)
Example123
ContentProviderName
string | null
The name of the content provider for this course (if any)
ExampleContent Prvider Name Sample
Activities
Array of object (Activity)
See Activity.
object
Id
integer (int32)
The activity's unique identifier
Example33345
ParentId
integer (int32) | null
The Id of the activity's parent activity (if any)
ActivityId
integer (int32)
The internal Id of the activity.
Example29119
ActivityTypeId
integer (int32)
The Id of the activity type:
- ScormModule = 2
- Lab = 4
- Survey = 10
- InstructorSurvey = 20
- OrganizationSurvey = 30
- ExternalLink = 40
- Assessment = 50
- Video = 60
- Document = 70 - Section = 80
Example4
ActivityTypeName
string
The activity's type name
ExampleLab
Name
string
The activity's name
ExampleActivity Name Sample
Description
string | null
The activity's description
ExampleActivity description sample
Subtitle
string | null
The activity's subtitle
AllowRetake
boolean
The activity's setting to allow retakes
ExampleTrue
AllowReview
boolean
The activity's setting to allow review
ExampleFalse
Url
string | null
The activity's url
SortOrder
integer (int32)
The activity's sort order index
Example0
Required
boolean
The activity's setting for if the activity is required for course completion
ExampleTrue
AvailabilityTypeId
integer (int32)
The activity's availablility type id
- Everyone = 0
- Instructors Only = 1
Example0
ExpectedDurationSeconds
integer (int32)
The activity's expected duration in seconds
Example3540
IsExam
boolean
The activity's setting as a scored lab (This only applies to Lab type activities)
ExampleFalse
Activities
Array of object (Activity)
See Activity.
object Recursive
Duration
number (float)
The course's duration.
Example144.5
DurationUnitId
integer (int32)
The course's duration type identification. Values include:
- Minutes = 0
- Hours = 1
- Days = 2
- Weeks = 3
Example2
Tags
Array of object (Tag)
See Tag.
object
Id
integer (int32)
The tag's unique identifier.
Example2
Name
string | null
The tag's name.
ExampleTag Example 1
CustomFields
Array of object (CustomField)
See CustomField
object
Name
string
The name of the custom field.
ExampleMyCustomText
TexValue
string
The value of the custom field.
ExampleWoohoo!
Created
integer (int64)
When the course was created. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1449496800
LastModified
integer (int64)
the course was last modified. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1584035120
Was this article helpful?