Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
Top
Objects visible through the public API:

Anchor
Students
Students
Students

...

Field NameDescriptionMaxLengthFormatExample DataNotes
CourseAssignIDThe unique identifying number associated with the course assignment8Integer1000This number is generated by the system when the course assignment is created.
To create new Enrollment/Course Assignment, this field is not required. To MODIFY an existing enrollment - due date, expiration date, this field is REQUIRED.
StudentNumberThe unique student id number in the LMS8Integer1000This number is generated by the system when the student is registered.
OrgCourseIDThe unique identifying number for the organization course in the course library database8Integer12345 
CompletionDateThe date and time the student completed the course.24DateTimeYYYY-MM-DD HH:MM:SS 
StatusThe status of the course enrollment in the LMS11StringNot Started, In Progress,Complete 
TrainingYearThe four digit year the training occurred in4Integer2016Will be automatically assigned by system based on calendar year of enrollment, but may be overridden by API call.
ExpirationDateThe date that access to the course will expire24DateTimeYYYY-MM-DD HH:MM:SSWill be automatically assigned by system based on OrgCourse Configuration, but may be overriden by API call.
CreatedDateThe date and time the course assignment was created in the LMS23DateTimeYYYY-MM-DD HH:MM:SSWill be automatically assigned by system
Created_ByThe unique number of the Administrator that created the course Assignment8Integer100002Will be automatically assigned by system
Date_UpdatedThe date and time the course assignment was updated in the LMS24DateTimeYYYY-MM-DD HH:MM:SSWill be automatically assigned by system
Updated_ByThe unique number of the Administrator that updated the course Assignment8Integer100002Will be automatically assigned by system
FileTransferNameHouses the file name, assumed to contain the date, that modified the Course Assignment record256StringsampleFile-03-16-2016.csvRead only, system generated when data integration completed via processing flat files.
CompletionMethodThe method used to complete the training9StringOnline, LiveEvent , OfflineWill be automatically assigned by system
StartDateThe date and time the student started taking the course24DateTimeYYYY-MM-DD HH:MM:SSWill be automatically recorded by system, not be edited via the API.
TimeSpentThe total raw minutes spent by the student to complete the training8Integer60Will be automatically recorded by system, not be edited via the API.
DueDateThe date the course assignment should be completed by24DateTimeYYYY-MM-DD HH:MM:SS 
ApprovalDateThe date and time the course assignment was approved24DateTimeYYYY-MM-DD HH:MM:SSWill be automatically recorded by system, not be edited via the API.
ApprovalAdminThe unique number of the Administrator that approved the course Assignment8Integer1000002Will be automatically recorded by system, not be edited via the API.
AccessCodeIDData field used when the customer will be using access codes or eCommerce8Int33nullTypically used for eCommerce implementations
OrderIDData field used when the customer will be using access codes or eCommerce8Int34nullTypically used for eCommerce implementations
ReqStatusThe required status of the course8StringAll, Required, OptionalThis value can NOT be edited at the Course Assignment level, it can only be updated at the OrgCourse level which cascades down to the Course Assignment, at the time of enrollment. OrgCourse changes made after course assignment(s) do NOT cascade down to existing course assignments.

Top of page

Anchor
Courses
Courses
Courses

An instance of a course. 

Field NameDescriptionMax LengthFormatExample DataNotes
CourseIDThe unique identifying number of the course in the LMS8IntegerAutomatically assigned by system 
StatusThe status of the course in the LMS10StringActive, Inactive 
TitleTitle of the course250StringHazard Communication 
DiplomaFile path to diploma template to generate on course completion100Stringdiploma/diploma.aspx 
InstanceTypeIndicator for whether the course was taken through the LMS or elsewhere50StringOnline, Offline 
SiteLessonID 8IntegerAutomatically assigned by system 
LessonTitle  String  
ReqStatusThe required status of the course String  
DueDaysPriorToExpireThe number of days prior to the course expiration that all assignments are due by8Integer Typically set to 90 by default.
Signup_Start_DateThe date and time the course is made available for enrollments24DateTimeYYYY-MM-DD HH:MM:SS 
Signup_End_DateThe date and time the course is is no longer available for enrollments24DateTimeYYYY-MM-DD HH:MM:SS 
SeatsThe number of seats available for the course8Integer  
OrgCourseIDThe unique identifying number of the organization course in the LMS8Integer  
OrgIDThe unique identifying number of the training organization associated with this course8Integer  
TimeRequiredThe minimum number of raw minutes required to complete the training8Integer  
ApprovalRequired 1BooleanTrue, False 
RecertificationDuration 8Integer  
OrganizationName of organization to which the course is assigned String  
LessonID 8Integer  
ReplacementCoursesID  StringComma delimmited list of CourseIDs to auto-enroll into during next enrollment window 
LessonNumber 8Integer  
OrgCourseStatusStatus of the OrgCourse instance record StringActive, Inactive 
CourseDefStatusStatus of the record in the Course Definition Table StringActive, Inactive 
Offline  String  

 

Anchor
OrgCourse
OrgCourse
Org Courses

An instance of a course as assigned to a training org.  Org course records provide the template used to populate Course Assignments records.  

Field NameDescriptionMaxLengthFormatExample DataNotes
OrgCourseIDThe unique identifying number of the organization course in the LMS8Integer1525 
OrgIDThe unique identifying number of the training organization associated with this course8Integer157 
CourseIDThe unique identifying number of course in the courses list8Integer  
ReqStatusThe required status of the course8StringRequired, Optional 
Signup_Start_DateThe date and time the course is startedmade available for enrollments24DateTimeYYYY-MM-DD HH:MM:SS 
Signup_End_DateThe date and time the course is completedis no longer available for enrollments24DateTimeYYYY-MM-DD HH:MM:SS 
SeatsThe number of seats available for the course8Integer25 
ActiveTrainingDurationThe length of time that an enrollment is active for3Integer365Typically set to 365 by default.
coursemessageidThe unique id associated with the student that is used course messages have been setup and enabled for a course8Integer11223344 
DueDaysPriorToExpireThe number of days prior to the course expiration that all assignments are due by3Integer14 
OrgCourseStatusThe status of the organization course in the LMS8StringActive, Inactive, ArchivedActive, Inactive status will show in reports, Archived status will not show up in reports.
TimeRequiredThe minimum number of raw minutes required to complete the training8Integer  
ApprovalRequiredIndicates if approval of completion is required1BooleanTrue, False 
RecertificationDurationThe schedule on which training has to be retaken, counted in days8Integer365 
ApprovalNotificationTypeIDThe unique identifying number associated with the approval notification8Integer1234 

Top of page

Anchor
DDO
DDO
DDO

DDO (short for Domain, Division, Org) is the hierarchical object used for grouping in reporting and in making assignments.  Domain is the top level entity and is the parent of one or more Divisions, which are the parent of one or more Orgs.

Field NameDescriptionMaxLengthFormatExample DataNotes
OrganizationThe name of the training organization in the LMS256StringMaintenance - FacilitiesThe lowest level of the LMS Hierarchy where courses are assigned, and students are associated with Orgs.
OrgIDThe unique identifying number of the training organization in theLMS8Integer156, 157Assigned by the system upon Org creation. Existence of the ID is required, using it as an API reference number is optional.
DivisionNameThe name of the division in the LMS256StringAdministrativeMiddle level in the LMS Hierarchy.
DivisionIdThe unique identifying numberassociated with the division inthe LMS8Integer1234 
DomainNameThe name of the domain in the LMS256StringACME Safety WorksTop level in the LMS Hierarchy.
DomainIDThe unique identifyin number ofthe domain in the LMS8Integer1234 

Top of page