Update Student Action

A field marked with an asterisk "*" indicates the field is a required input for this action.

This action can be used to update the personal information of a student.

Input Fields

Field Description

Person ID*

A valid "Person ID" is not the "Banner ID", so do not confuse the two IDs. If unsure of the "Person ID" for a Student, it can be found via a Search Student action.

Name

A Name may be mapped to the "empty" type. The user can update a Name that has the "empty" type mapping but cannot use the update action to create a new Name with the "empty" type (this can only be added during the creation of a student in the Banner system).

A Student can have more than one name, so the Name type to update must be mapped in the connection object.

Existing Name sub-fields not selected will remain the previous value, such as Name/Middle Name.

There is no particular format for the fields.

ClosedSee the Name sub-fields.

  • First Name: May not be cleared.
  • Last Name: May not be cleared.
  • Middle Name: May be cleared.
  • Pedigree: May be cleared.

Email/Email Address

A Student can have more than one email type in Banner, so which email type the user wants to update must be mapped in the connection.

A Student can have multiple emails of the same type.

Acts as a put operation: if an email address of "type" already exists and an update with "type" is performed, then all the existing Email with that type will be overwritten.

If the user sends an update request with an empty "Email/Email Address" field, then all emails of the mapped type will be removed.

There is no particular format for the field.

Billing Address

Mailing Address

The fields for Billing Address and Mailing Address are identical.

A Student can have more than one address type in Banner, so which address type the user wants to update must be mapped in the connection.

A Student can only have one address for each type.

Acts as a patch operation: if an Address of "type" already exists and an update is performed, then the old address and new address will be merged with preference for the new input (i.e. old Billing Address/State is "US-NC" and old Billing Address/City is "City1", and new Billing Address/City is "City2" but no Billing Address/State is provided then the updated address will have Billing Address/State as "US-NC" and Billing Address/City as "City2").

Requires at least the "Address" field to create a new Address.

ClosedSee the Address sub-fields.

  • Address: A list of strings. Any more than four will be cut off.
  • City: Has no particular format.
  • Country: A 3 letter ISO 3166-1 string (e.g. USA).
  • Postal Code: Has a different format depending on the input for "country" and is validated so must follow the format of the Country selected.
  • State: An ISO 3166-2 string (e.g. US-NC)

Home Phone

Mobile Phone

A Student can have more than one Phone, so the Phone type to update must be mapped in the connection object.

A Student can have multiple Phones of the same type.

Acts as a put operation: if a Phone/multiple Phones of "type" already exists and an update is performed, then all existing phones with that "type" will be overwritten.

Requires the "Home/Mobile/Number" field to create a new Phone entry.

ClosedSee the Phone sub-fields.

  • Country Code: A 4-character string the can have a preceding '+' (the 4 character limit includes the '+').
  • Extension: A string that is at most 10 characters.
  • Number: A string that is at least 1 character, can be any length but is cut off after 18 characters.

Ethnicity

Updated by setting an "Ethnicity - ID (Value)" (Guid)

Other associated fields will automatically be updated (Ethnicity - Description, Ethnicity - Title).

Marital Status

Updated by selecting a "Marital Status - Marital Category(Value)"

Other associated fields will automatically be updated (Marital Status - ID, Marital Status - Code, Marital Status - Title).

SSN

Updated by inputting a new value string.

Gender

Updated by selecting a "Gender”.

Available gender strings are:

  • Male
  • Female
  • Unknown

Genders are case sensitive.

Date of Birth

Updated by selecting a new date

Note: you can use any valid date format (though through Lookup enter it via a date input box rather than single line input)

Citizenship Country

Updated by selecting a Country.

Format: 3 letter ISO 3166-1 string.

Output

This action does not have any output tokens.

Update Student Notes:

For most Ellucian fields, adding the field to input and giving it no value will clear it.

For certain fields which type mapping (Billing/Mailing Address, Home/Mobile Phone, Email) to remove a full entry you must add each sub-field in the input and leave all of them empty. For example, if the user inputs an empty Home Phone/Number, Extension and Country Calling Code then all the existing home phones will be cleared.