|
Field Name
|
Required
|
Data Type
|
Value Range
|
Description
|
|
institution_id
|
Required
|
String
|
|
A unique identifier used to reference users in the enrollments table. This identifier should not be changed and must be globally unique.
|
|
first_name
|
Required
|
String
|
|
|
|
last_name
|
Required
|
String
|
|
|
|
primary_email
|
Required
|
String
|
Valid Email
|
should be unique for each user
|
|
status
|
Required
|
Enum
|
active
deleted
alumni
inactive
parent
|
This status would be matched to the status of the user in CN. The “deleted” value equals to "dropped off" in CN.
|
|
password
|
Optional
|
String
|
|
This field sets the password for users. This field is optional and users can create their CN Password on their own.
|
|
user_label
|
Optional
|
String
|
|
Institution admins need to create user labels from the Manage User Labels tab first. For adding multiple labels you would need to separate them using “|”. For example, “FirstYear|Staff” will associate two labels, “FirstYear” and “Staff” to the assigned users.
|
|
login_id
|
Optional
|
String
|
|
This value can be used to match the user with an external server such as LDAP or CAS as external authentication server
|
|
sis_id
|
Optional
|
String
|
|
A secondary unique identifier is useful for more complex SIS integrations. This identifier should not be changed and must be globally unique.
|
|
full_name
|
Optional
|
String
|
|
|
|
birth_date
|
Recommended
|
DateTime
|
e.g. YYYY-MM-DDTHH:MM:SSZ
|
CN will not display this information on the website. It will only be recorded internally for permission granting purposes. For example, younger students' ePortfolio page will not be public facing based on their institution's setting.
|
|
gender
|
Optional
|
Int
|
0 = not known,
1 = male,
2 = female,
9 = not applicable
|
|
|
creation_date
|
Optional
|
DateTime
|
e.g. YYYY-MM-DDTHH:MM:SSZ
|
|
|
expiration_date
|
Optional
|
DateTime
|
e.g. YYYY-MM-DDT00:00:00Z
|
After this date, CN will automatically change the member's status to "Inactive". This status will prevent the member from logging into CN.
|
|
admission_date
|
Optional
|
DateTime
|
e.g. YYYY-MM-DDTHH:MM:SSZ
|
This creation date is the date of creation for the user record on the student information system of the institution.
CN may use this data to label the start date of the certified institution logo on user ePortfolios.
|
|
major_minor
|
Recommended
|
String
|
|
This data will be used to fill the Major/Study Area field and to automatically generate skill tags on user ePortfolio/profile page. You can use "|" to seperate multiple terms.
|
|
secondary_email
|
SR
|
String
|
Valid Email
|
|
|
grade_level
|
Recommended
|
String
|
Description => Code
Infant/toddler => IT
Preschool => PR
Prekindergarten => PK
Transitional Kindergarten => TK
Kindergarten => KG
First grade => 01
Second grade => 02
Third grade => 03
Please go to Description
|
Complete list of codes and Description:
CN will not display this information on the website. It will only be recorded internally for permission granting purposes. For example, younger students' ePortfolio page will not be public facing based on their institution's setting
|
|
country
|
Recommended
|
String
|
|
Country of current residency.
This will be used to fill the Country/Region field and to display the flag on user ePortfolio/profile page.
|
|
state
|
Optional
|
String
|
|
This will be used to fill the State/Province field on user ePortfolio/profile page.
|
|
city
|
Optional
|
String
|
|
This will be used to fill the City field on user ePortfolio/profile page.
|
|
nationality
|
Optional
|
String
|
Country Name
|
CN will not display this information on the website. It will only be recorded internally. |
|
primary_language
|
Optional
|
String
|
|
This will be used to fill the Primary Language field on user ePortfolio/profile page.
|
|
institutional_role
|
Optional
|
String
|
Student
Faculty
Member
Instructor
Mentor
Staff
Alumni
ProspectiveStudent
Guest
Other
Administrator
Observer
Parent/Guardian
None
|
This role is basically the role of the user within the institution which is different than the role within the course.
This will be used to fill the Role/Status field on user ePortfolio/profile page.
|
|
|
|
|
|
CN will not display this information on the website. It will only be recorded internally.
|
|
bio
|
Optional
|
String
|
Any text without carriage return (new line, Enter)
|
This value would be shown as Introduction under the About section on user ePortfolio/profile page.
|
|
primary_institution
|
Optional
|
String
|
|
This is what will appear on a user’s ePortfolio as Primary Institution. Without such a field on the user import CSV, it will be the licensed institution's name by default.
|
Comments
0 comments
Article is closed for comments.