Course Record Import - Data Dictionary

The following dictionary is used when importing a CSV in to EthosCE.

For more information on updating course record imports via web services, see Enrollment/Credits - Web Service Data Structures and Web Services - Date Formatting for the proper syntax and formatting.

Field name

Required

Format

Notes

Field name

Required

Format

Notes

external_course_id

Global importer: Yes

Course importer: No

alphanumeric

A unique identifier for the course associated with each import row. This will match with the "external ID" field of a course. Only required when importing to the global importer.

Limited to 128 characters.

title

Global importer: Yes

Course importer: No

alphanumeric

The title of the course associated with each import row. Only required when importing to the global importer.

external_user_id

Either external_user_id or external_mail is required. 

alphanumeric

A unique id for the user associated with each import row.  Customers with SSO can use the external_user_id to match users with course records.

external_email

Either external_user_id or external_email is required. 

alphanumeric

The email of the user associated with the credit record. Used to match the import record with a user.

first_name

No

alphanumeric

The first name of the user associated with the credit record.

last_name

No

alphanumeric

The last name of the user associcated with the credit recort.

enrollment_start

No

ISO 8601

The date the learner's enrollment happened. When this date is included a record will be counted for PARS or JA PARS (if enabled). Requires a value in the participant_category field.

enrollment_end

No

ISO 8601

The date the learner's enrollment ends.

credits

No

decimal (6.2)

The number of credits.

credit_type

No

alphanumeric

The type of credits. Must use the values defined for each EthosCE implementation. If you don't know what these are, please check before importing.

credit_expiration

No

ISO 8601

The expiration date of the credit record.

complete

No

boolean

1 if the course was completed by the user associated with the credit record.
0 if the course was not completed by the user associated with the credit record.

date_completed

No

ISO 8601

The date the credit was awarded. If a date is not present and the import record has a 1 in the "complete" column, then the date of the user's next login will be used for completion date.

attended

No

boolean

1 if the user attended.
0 if the user did not attend.

city

No

alphanumeric

255 characters maximum.

province

No

ISO-3166-2



country

No

ISO-3166-2



participant_category

No



Requires a value in the enrollment_start field.

This value is passed directly to the PARS XML. Use "physician" or "non-physician" to include the record in PARS.

For JA PARS use "physician," "nurse," "other," "physician assistant," psychologist," "optometrist," "social worker," "dentist," or "allied dental staff."

The global course report importer should only be used for importing legacy data. It is not included in PARS reports. To include in PARS, use the course-level importer.