Search Student by Banner ID Action

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

This action could be used for searching all the personal information of a student and returns one or no results.

Input Fields

Field Description

Banner ID*

Is the Guid identifier for the searched student.

User must input Banner Id exactly as is on Ellucian.

Output Fields

Returns a single result set.

Field Description

Banner Username

The Username for the searched student on Ellucian.

Billing Address

Mailing Address

Billing and Mailing addresses are identical in format.

Requires additional API call.

ClosedSee the Address sub-fields.

  • Address: A list of strings.
  • 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)

Citizenship Country

A 3 letter ISO 3166-1 string (e.g. USA)

Date of Birth

A date string.

Email/Email Address

A list of strings.

Ethnicity

Includes sub-fields: Ethnicity ID (Value), Title

Requires additional API call

Gender

Includes sub-fields: Ethnicity ID (Value), Title

Requires additional API call

Home Phone

Mobile Phone

Home and Mobile Phone fields are identical in format.

Includes sub-fields.

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.

Marital Status

Includes sub-fields: Marital Category (Value), Marital Category ID, Code, Title

Requires additional API call

Name

Includes sub-fields: First Name, Last Name, Middle Name and Pedigree

Person ID

Is the Guid identifier of the student

SSN

Male/Female/Unknown (case sensitive)

Student Terms

Requires additional API call

Includes sub-fields.

ClosedSee the Student Terms sub-fields.

  • Student Terms/Student Term ID: The Guid identifier for the Student Term.
  • Student Terms/Academic Levels: Requires additional API call, and has additional sub-fields (ClosedSee the Academic Levels sub-fields).
    • Academic Level/Academic Level ID: The Guid identifier for the academic levels under the Student Term.
    • Academic Level/Code: The code that identifies the academic levels under the Student Term (for example, ‘UG’).
    • Academic Level/Title: The full name of the academic levels under the Student Term (for example, ‘Undergraduate’).
    • Priority: The priority of an Academic Level for a given period (for example, "primary").
  • Student Terms/Term: Requires additional API call and includes sub-fields. ClosedSee the Term sub-fields.
    • Term ID: The Guid identifier for the term under the Student term.
    • Code: The code that identifies the academic period under the Student Term (for example, ‘UG’).
    • Title: The full name of the term under the Student Term (for example, ‘Undergraduate’)
    • Registration: The availability for registration for the term under the Student Term (for example, 'open')
    • Start On: The date the term under the Student Term starts/started (for example, ‘2015-01-05T00:00:00+00:00’)
    • End On: The date the term under the Student Term ends/ended (for example, ‘2016-01-05T00:00:00+00:00’)

Search Student by Banner ID Notes:

For fields with mapping, the search results will reflect the mappings. For example, if a connection has "Name" mapped to "Legal" and a search is performed on a Student with no "Legal" name, then the "Name" fields in the results will be empty.

Student Term is a collection for each Student, they are sorted by Academic Period - Start On.

Academic levels is a collection under Student Term.

The academic levels listed under Student Terms, they are all the academic levels of any programs the student was actively enrolled in for that specific term.

For the Student Terms under the Student model, each represents a Term that the student was enrolled in an active program. These will not be removed after the student has completed the term and/or the program.