LIS 2.0 Person

Comment 

Learn Object Relationship

SOAP-ENV Body element and element defining the request operation

This sourcedId is the source Id for message

None

Begin the person record block 

None

The SourcedGUID providing the unique identifier for this person record and the source of the identifier 

BATCH UID :: Person SourcedId

Begin the person data 

None

One component LIS formatting style is the blocking of elements and their attributes between supporting defining elements. In this case the formal name (formname), the Full name is blocked between identifiers which provide the language used for the data - in this case en, the textString - in this case Full, and the textString containing the actual data for the formattedName - in this case Dr. First Middle Last, Jr.

Note the instanceVocabulary provides the IMS vocabulary for the object in question.

None

An additional LIS style is the support for components of a multipart object such as a name which may be build from prefix, first, middle, last, and suffix parts. This is handled through the addition of "parts". Combined with the instance elements these multipart objects are easily describable and are enclosed in descriptive partName elements.

Learn Title :: Person:Name:Prefix

Learn First Name :: Person:Name:Given

Learn Middle Name :: Person:Name:Middle

Learn Last Name :: Person:Name:Last

Learn Title :: Person:Name:Suffix

Not supported by Learn:

Person:Name:Nickname

The person address block follows the same pattern as the above name block. 

Learn Street1 ::

    Person:Address: NonFieldedStreetAddress1

Learn Street2 ::

    Person:Address:NonFieldedStreetAddress2

Learn City ::

    Person:Address:City

Learn State/Province ::

    Person:Address:StatePr

Learn Zip/Postal code::

    Person:Address:Postcode

Learn Country ::

    Person:Address:Country

Contactinfo provides the email address associated with this person record.

Learn email :: Person:ContactInfo:EmailPrimary

This section provides demographics information such as gender, date of birth, etc. 

Learn Birthdate :: Person:DemographicInfo:Birth

Learn Gender :: Person:DemographicInfo:Gender

Not supported by Learn

Person:Demographics:Death

Person:Demographics:MaritalStatus

Person:Demographics:Ethnicity

The roles section provides the institutional role and account login information (username and password) for this person record. 

Learn Primary Institution Role :: Person:Roles:Role:InstitutionRole

Learn System Role :: Person:Roles:Role:InstitutionRole

See "Institution Roles" or "System Roles" in the System Admin panel for lists of valid Institution and System Roles.

Learn Username and Student ID::

Person:Roles:Role:userId

Learn Password:

Person:Roles:Role:Password

Learn Password Encryption Type:

Person:Roles:Role:PwEncryptionType

Important!

Learn only uses the last userId record - if multiple userId records are provided ensure that the login information - username and password - are in the last userId record. So this sample person would login to Learn using

username: user_firstlastname

password: change_me

Not supported by Learn

authenticationType

<extension>
       <extensionNameVocabulary>unknown</extensionNameVocabulary>
       <extensionValueType>unknown</extensionValueType> 
       <extensionField> 
              <fieldName>inst_email</fieldName> 
              <fieldType>unknown</fieldType> 
              <fieldValue>[email protected]</fieldValue> 
       </extensionField> 
</extension>

<extension>
   <extensionNameVocabulary>unknown</extensionNameVocabulary>.
   <extensionValueType>unknown</extensionValueType>
   <extensionField>
       <fieldName>pronouns</fieldName>
       <fieldType>unknown</fieldType
       <fieldValue>they/them,she/her,ze/zir</fieldValue>
   </extensionField>
</extension>

Institution email is distinct from personal email and used for integrations requiring use of an official address such as the Microsoft Teams integration. Administrators can edit the institution through the SIS Framework, but there is no option for end users to edit.

There are 2 scenarios to be considered:

     A. When Person Email is the Institution Email
     B. When Person Email isn’t the institution email

Person Email is the Institution Email

For scenario A, the Institution Email (inst_email) is by default set to person email within the SIS integration specifications, and therefore no additional action is required to change this on behalf of the administrator.

Person Email isn’t the institution email

For scenario B, when the person email field isn’t the institution email address and there is a need to update/change this, it’s possible to use a script to populate the institutional email field values using field mapping rather than directly adding data to this field.

This is an example script for populating the institution email field using the Use a custom script text box:

(function() {
     var v = data.person.extensions.get('inst_email'); 
     return v ? v.value : null;
}());

It’s important to note that if required, an admin can revert the field mapping back to ‘Person Email’. If a custom script has been used, this will be preserved.

Multiple pronoun values for a person

It’s possible to send multiple pronoun values per student. This is sent as a single fieldValue entry with the different values separated by commas.

<extension>
       <extensionNameVocabulary>unknown</extensionNameVocabulary>
       <extensionValueType>unknown</extensionValueType>
       <extensionField>
              <fieldName>pronunciation</fieldName>
              <fieldType>unknown</fieldType>
              <fieldValue>kris-chun</fieldValue>
       </extensionField>
</extension>

Name pronunciation

The name pronunciation field is text (unicode) to support phonetic spelling or a pronunciation guide. Exchange of audio recording files aren’t supported with the SIS integration framework.