Learning Input

Input representation of the details that define an instructional object, which can be made available as a course, program, or an on-site experience for a contact.

JSON Example 

1{
2"type": "Learning Course",
3        "name": "Advanced Data Structures and Algorithms",
4        "provider": "001LT000009puL0YAI",
5        "description": "This course covers advanced concepts in data structures and algorithms, with a focus on efficient problem-solving and coding techniques.",
6        "courseLevelDescription": "Graduate-level course focusing on advanced data structures and algorithms.",
7        "subjectAbbreviation": "CS",
8        "fieldOfStudy": "Computer Science",
9        "courseNumber": 601,
10        "active": true,
11        "activeFromDate": "2024-09-01T00:00:00.00Z",
12        "activeToDate": "2025-12-31T23:59:62.00Z",
13        "duration": 4,
14        "durationUnit": "Credit Hours",
15        "cipCode": "11.0101",
16        "academicLevel": "Graduate"
17}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
academicLevelStringAcademic level of the learning.
Applicable for both learning program and learning course.
Optional62.0
activeBooleanIndicates whether the learning is active (true) or not (false).
Applicable for both learning program and learning course.
Optional62.0
active​FromDateStringStart date of the learning’s active period.
Applicable for both learning program and learning course.
Optional62.0
activeToDateStringEnd date of the learning’s active period.
Applicable for both learning program and learning course.
Optional62.0
cipCodeStringClassification of the instructional programming code that identifies the program or field of study.
Applicable for both learning program and learning course.
Optional62.0
courseLevel​DescriptionStringGeneral type or level of instruction provided by the learning course.
Applicable for learning course only.
Optional62.0
courseNumberStringNumeric ID of the course.
Applicable for learning course only.
Optional62.0
descriptionStringDescription of the learning.
Applicable for both learning program and learning course.
Optional62.0
durationDoubleAllocated duration to complete the learning.
Applicable for both learning program and learning course.
Optional62.0
durationUnitStringUnit of the duration that’s allocated to complete the learning.
Applicable for both learning program and learning course.
Optional62.0
fieldOfStudyStringField of study of the learning course.
Applicable for learning course only.
Optional62.0
learningIdStringID of the learning.
Applicable for both learning program and learning course.
Required62.0
learningCourse​CustomFieldsMap<String, Object>Custom fields on the learning course.
Applicable for learning course only.
Optional62.0
learning​CourseIdStringID associated with the learning course.
Applicable for learning course only.
Optional62.0
learningProgram​CustomFieldsMap<String, Object>Custom fields on the learning program.
Applicable for learning program only.
Optional62.0
learning​ProgramIdStringID associated with the learning program.
Applicable for learning program only.
Optional62.0
nameStringName of the learning.
Applicable for both learning program and learning course.
Optional62.0
providerStringAccount foreign key identifier of the institution that provides the learning.
Applicable for both learning program and learning course.
Optional62.0
subject​AbbreviationStringAbbreviation for the subject of the learning course.
Applicable for learning course only.
Optional62.0
topLevel​ProgramBooleanIndicates whether the learning program is a top-level program (true) or not (false).
Applicable for learning program only.
Optional62.0
typeStringType of learning record.
Valid values are:
  • Learning Program
  • Learning Course

Applicable for both learning program and learning course.
Required62.0