Objects visible through the public API:
Students
Represents a user who can be assigned training in the system.
| Field Name | Description | Size | Format | Example Data | Notes |
| StudentNumber | The unique student id number in the LMS | 8 | Integer | 1000 | This number is generated by the system when the student is registered. |
| Status | Student enrollment status | 8 | String | Active, Inactive, Archived | Active, Inactive status will show in reports, Archived status will not show up in reports |
| Student_Id | User name for student account, used to for non-SSO logins | 50 | String | jdoe@yourorg.com | Should be email address or, for those users without email, first initial and last name at company domain. For users without email leave off .com/org/net/edu portion of domain name |
| Password | Password for user account to access the LMS | 100 | String | A password value is still required when using SSO as the primary login method. Should SSO be the only available login method a random 16 character string is recommended | |
| Last_Name | Surname | 50 | String | Doe, Public, Smith, etc. | |
| First_Name | Given name | 50 | String | John, Mary, Ismael, etc. | |
| Middle_Initial | Middle name or initial | 20 | String | Q | |
| Company_Name | Name of employer or institution | 150 | String | ||
| OrgID | The unique identifying number for the organization in the LMS | 8 | Integer | 157 | The Organization to which a student is assigned will determine the student's training assignments, notifications, and reporting visibility |
| Location | Available as a filter in reports and views | 50 | String | East building | This field is a report filter field |
| Institution assigned email address | 256 | String | jdoe@yourorg.com | ||
| Phone | Local facility, office or residence phone number with area code | 20 | String | 15551212 | |
| Address1 | Local facility, office, or residence street address | 50 | String | 123 Any Street | |
| Address2 | Local facility, office, or residence street address | 50 | String | Apt. # 3 | |
| City | Local facility, office, or residence city | 50 | String | Pasco | |
| State | Local facility, office, or residence state code or province | 50 | String | WA | |
| Zip | Local facility, office, or residence postal code | 15 | String | 99301 | |
| License_Number | Represents the student's Drivers License, DOT license, or other certification numbers that don’t change | String | NCDL1909591A | ||
| RegistrationDate | Date the student is registered in the LMS | DateTime | YYYY-MM-DD HH:MM:SS | Generated by the System. | |
| Supervisor | Name of the student's supervisor | String | Smith, William | This field holds client supplied information. It displays on reports but does not effect notifications, training assignments, or other LMS operations | |
| Supervisor_Email | Email address of supervisor | 256 | String | wsmith@yourcompany.org | This field holds client supplied information. It displays on reports but does not effect notifications, training assignments, or other LMS operations |
| Created_By | The user number of the LMS Administrator that created the student record | Integer | 100002 | Generated by the System. | |
| Language | The language preference of the student for the LMS Interface. (Does not affect language of content) | String | en-us | ||
| Employee_ID | The unique id given to the employee by their employer | String | 00736215 | ||
| Hire_Date | Date and time the individual was hired | DateTime | YYYY-MM-DD HH:MM:SS | ||
| Region | The region, area, city, town or other descriptor for where the student is employed | String | North-West | This field is a report filter field | |
| Pin | Personal Identification number of the student | Integer | 1234 | ||
| Title | The honorific for the student | String | Mr., Mrs., Ms, Hon., Dr., etc. | ||
| Job_Type | The numeric (classified) or alpha-numeric (unclassified) value that corresponds to a unique JobTitle in HRS or Title Code in the legacy system | String | 13903 | ||
| Employee_Type | A classification system used to group employees with certain attributes assigned to a job record to group jobs with similar attributes. | String | FA | ||
| Country | Country where the student resides | String | United States | ||
| Suffix | Generational title or post-nominal letters | String | Jr.,II,II, Ph.D., Esq, etc. | ||
| UserType | Indicates the type of account associated with the student | String | Student | Assigned by the system and usually set to "Student" by default | |
| Address1_2 | Local facility, office, or residence street address | String | 123 Any Street | ||
| Address2_2 | Local facility, office, or residence street address | String | Apt. # 3 | ||
| City_2 | Local facility, office, or residence city | String | Stevens Point | ||
| State_2 | Local facility, office, or residence state code | String | WI | ||
| Zip_2 | Local facility, office, or residence postal code or postal code + 4 | String | 54481 | ||
| Department | The department name/code for which the employee works | String | Info Tech, K101500 | This field is a report filter field | |
| DriversLicenseLastFour | The last four digits of the students drivers license number | Integer | 0909 | Typically used for eCommerce implementations | |
| Phone_2 | Local facility, office or residence phone number | String | 15551212 | ||
| Email_2 | Institution assigned, or personal email address | String | you@youremail.com | ||
| Profession | The job code descriptor for the job_type held by the student | String | IS SUP TECH SR | ||
| Hear_About_Us | How the student heard about the company | String | Employer | Typically used for eCommerce implementations | |
| Future_Communication | Student wishes to receive future communications from the company selling the content they purchased. | Boolean | True, False | Typically used for eCommerce implementations | |
| Notes | Field for admins to capture notes on the student account, not viewable by student, viewable to all admins. | String | |||
| ChapterName | The chapter of the primary professional organization the student belongs to | String | NE, 101, null | ||
| GrantApplicationNumber | The unique number associated with the grant used to cover enrollment and course related costs | Integer | HM1234, null | ||
| AICCStudentID | Unique system assigned number to facilitate AICC course communication | Integer | Generated by the System. |
Course Assignments
Represents an assigned unit of training
| Field Name | Description | MaxLength | Format | Example Data | Notes |
| CourseAssignID | The unique identifying number associated with the course assignment | 8 | Integer | 1000 | This 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. |
| StudentNumber | The unique student id number in the LMS | 8 | Integer | 1000 | This number is generated by the system when the student is registered. |
| OrgCourseID | The unique identifying number for the organization course in the course library database | 8 | Integer | 12345 | |
| CompletionDate | The date and time the student completed the course. | 24 | DateTime | YYYY-MM-DD HH:MM:SS | |
| Status | The status of the enrollment in the LMS | 11 | String | Not Started, In Progress,Complete | |
| TrainingYear | The four digit year the training occurred in | 4 | Integer | 2016 | Will be automatically assigned by system based on calendar year of enrollment, but may be overridden by API call. |
| ExpirationDate | The date that access to the course will expire | 24 | DateTime | YYYY-MM-DD HH:MM:SS | Will be automatically assigned by system based on OrgCourse Configuration, but may be overriden by API call. |
| CreatedDate | The date and time the course assignment was created in the LMS | 23 | DateTime | YYYY-MM-DD HH:MM:SS | Will be automatically assigned by system |
| Created_By | The unique number of the Administrator that created the course Assignment | 8 | Integer | 100002 | Will be automatically assigned by system |
| Date_Updated | The date and time the course assignment was updated in the LMS | 24 | DateTime | YYYY-MM-DD HH:MM:SS | Will be automatically assigned by system |
| Updated_By | The unique number of the Administrator that updated the course Assignment | 8 | Integer | 100002 | Will be automatically assigned by system |
| FileTransferName | Houses the file name, assumed to contain the date, that modified the Course Assignment record | 256 | String | sampleFile-03-16-2016.csv | Read only, system generated when data integration completed via processing flat files. |
| CompletionMethod | The method used to complete the training | 9 | String | Online, LiveEvent , Offline | Will be automatically assigned by system |
| StartDate | The date and time the student started taking the course | 24 | DateTime | YYYY-MM-DD HH:MM:SS | Will be automatically recorded by system, not be edited via the API. |
| TimeSpent | The total raw minutes spent by the student to complete the training | 8 | Integer | 60 | Will be automatically recorded by system, not be edited via the API. |
| DueDate | The date the course assignment should be completed by | 24 | DateTime | YYYY-MM-DD HH:MM:SS | |
| ApprovalDate | The date and time the course assignment was approved | 24 | DateTime | YYYY-MM-DD HH:MM:SS | Will be automatically recorded by system, not be edited via the API. |
| ApprovalAdmin | The unique number of the Administrator that approved the course Assignment | 8 | Integer | 1000002 | Will be automatically recorded by system, not be edited via the API. |
| AccessCodeID | Data field used when the customer will be using access codes or eCommerce | 8 | Int33 | null | Typically used for eCommerce implementations |
| OrderID | Data field used when the customer will be using access codes or eCommerce | 8 | Int34 | null | Typically used for eCommerce implementations |
| ReqStatus | The required status of the course | 8 | String | All, Required, Optional | This 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. |
Courses
An instance of a course.
| Field Name | Description | Max Length | Format | Example Data | Notes |
|---|---|---|---|---|---|
| CourseID | The unique identifying number of the course in the LMS | 8 | Integer | Automatically assigned by system | |
| Status | The status of the course in the LMS | 10 | String | Active, Inactive | |
| Title | Title of the course | 250 | String | Hazard Communication | |
| Diploma | File path to diploma template to generate on course completion | 100 | String | diploma/diploma.aspx | |
| InstanceType | Indicator for whether the course was taken through the LMS or elsewhere | 50 | String | Online, Offline | |
| SiteLessonID | 8 | Integer | Automatically assigned by system | ||
| LessonTitle | String | ||||
| ReqStatus | The required status of the course | String | |||
| DueDaysPriorToExpire | The number of days prior to the course expiration that all assignments are due by | 8 | Integer | Typically set to 90 by default. | |
| Signup_Start_Date | The date and time the course is made available for enrollments | 24 | DateTime | YYYY-MM-DD HH:MM:SS | |
| Signup_End_Date | The date and time the course is is no longer available for enrollments | 24 | DateTime | YYYY-MM-DD HH:MM:SS | |
| Seats | The number of seats available for the course | 8 | Integer | ||
| OrgCourseID | The unique identifying number of the organization course in the LMS | 8 | Integer | ||
| OrgID | The unique identifying number of the training organization associated with this course | 8 | Integer | ||
| TimeRequired | The minimum number of raw minutes required to complete the training | 8 | Integer | ||
| ApprovalRequired | 1 | Boolean | True, False | ||
| RecertificationDuration | 8 | Integer | |||
| Organization | Name of organization to which the course is assigned | String | |||
| LessonID | 8 | Integer | |||
| ReplacementCoursesID | String | Comma delimmited list of CourseIDs to auto-enroll into during next enrollment window | |||
| LessonNumber | 8 | Integer | |||
| OrgCourseStatus | Status of the OrgCourse instance record | String | Active, Inactive | ||
| CourseDefStatus | Status of the record in the Course Definition Table | String | Active, Inactive | ||
| Offline | String |
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 Name | Description | MaxLength | Format | Example Data | Notes |
| OrgCourseID | The unique identifying number of the organization course in the LMS | 8 | Integer | 1525 | |
| OrgID | The unique identifying number of the training organization associated with this course | 8 | Integer | 157 | |
| CourseID | The unique identifying number of course in the courses list | 8 | Integer | ||
| ReqStatus | The required status of the course | 8 | String | Required, Optional | |
| Signup_Start_Date | The date and time the course is made available for enrollments | 24 | DateTime | YYYY-MM-DD HH:MM:SS | |
| Signup_End_Date | The date and time the course is is no longer available for enrollments | 24 | DateTime | YYYY-MM-DD HH:MM:SS | |
| Seats | The number of seats available for the course | 8 | Integer | 25 | |
| ActiveTrainingDuration | The length of time that an enrollment is active for | 3 | Integer | 365 | Typically set to 365 by default. |
| coursemessageid | The unique id associated with the student that is used course messages have been setup and enabled for a course | 8 | Integer | 11223344 | |
| DueDaysPriorToExpire | The number of days prior to the course expiration that all assignments are due by | 3 | Integer | 14 | |
| OrgCourseStatus | The status of the organization course in the LMS | 8 | String | Active, Inactive, Archived | Active, Inactive status will show in reports, Archived status will not show up in reports. |
| TimeRequired | The minimum number of raw minutes required to complete the training | 8 | Integer | ||
| ApprovalRequired | Indicates if approval of completion is required | 1 | Boolean | True, False | |
| RecertificationDuration | The schedule on which training has to be retaken, counted in days | 8 | Integer | 365 | |
| ApprovalNotificationTypeID | The unique identifying number associated with the approval notification | 8 | Integer | 1234 |
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 Name | Description | MaxLength | Format | Example Data | Notes |
| Organization | The name of the training organization in the LMS | 256 | String | Maintenance - Facilities | The lowest level of the LMS Hierarchy where courses are assigned, and students are associated with Orgs. |
| OrgID | The unique identifying number of the training organization in theLMS | 8 | Integer | 156, 157 | Assigned by the system upon Org creation. Existence of the ID is required, using it as an API reference number is optional. |
| DivisionName | The name of the division in the LMS | 256 | String | Administrative | Middle level in the LMS Hierarchy. |
| DivisionId | The unique identifying numberassociated with the division inthe LMS | 8 | Integer | 1234 | |
| DomainName | The name of the domain in the LMS | 256 | String | ACME Safety Works | Top level in the LMS Hierarchy. |
| DomainID | The unique identifyin number ofthe domain in the LMS | 8 | Integer | 1234 |