Ellucian Colleague - Advisor - Ex Libris Knowledge Center

Overview and Prerequisites

Prior to reviewing this page, please review the Ellucian Colleague Integration Directory page, including prerequisites found here.

User Experience

The My Advisor service allows a student to view contact information for their advisor and/or key contacts. Functionality includes:

Display user's assigned advisor(s)
Display advisor type and advisor's contact information including; office location, phone number and email address

Tile

Property	Static Tile
Default Size	1x1
Minimum Size	1x1
Suggested Design

Screenshots

Sample Requests

To enable the events services the following request and responses are supported.

Sample Request
colleagueapi/students/{studentId}

Sample Response
{ "DegreePlanId":160, "ProgramIds":[ "BS.CIS" ], "StudentRestrictionIds":[ "93002", "148510", "133847", "123706", "127558", "114314", "107577", "92330", "85970", "85730" ], "HasAdvisor":true, "PreferredEmailAddress":"student@university.edu", "IsLegacyStudent":false, "IsFirstGenerationStudent":null, "IsInternationalStudent":false, "AdmitTerms":[ "14/U1" ], "AcademicLevelCodes":[ "UG" ], "ResidencyStatus":"RESIDENT", "HighSchoolGpas":[ { "HighSchoolId":"0163328", "Gpa":2.3, "LastAttendedYear":"2014" } ], "Advisements":[ { "AdvisorId":"0361012", "StartDate":"2016-08-03T00:00:00", "EndDate":null, "AdvisorType":"MAJOR" } ], "StudentTypeCode":"UG", "ClassLevelCodes":[ "JR" ], "IsConfidential":false, "AdvisorIds":[ "0361012" ], "IsTransfer":false, "FinancialAidCounselorId":null, "EmailAddresses":[ { "Value":"student@university.edu", "TypeCode":"CC", "IsPreferred":true }, { "Value":"example.student@gmail.com", "TypeCode":"PR1", "IsPreferred":false } ], "StudentHomeLocations":[ ], "Id":"0475525", "LastName":"Student", "FirstName":"Ima", "MiddleName":"A", "BirthNameLast":null, "BirthNameFirst":null, "BirthNameMiddle":null, "PreferredName":"Ms. Ima A. Student", "PreferredAddress":[ "1446 Washington Ave", "Apt. 15", "Bronx, NY 10461" ], "Prefix":"Ms.", "Suffix":"", "Gender":"F", "BirthDate":"1996-04-29T00:00:00", "GovernmentId":"123-45-6789", "RaceCodes":[ ], "EthnicCodes":[ "HIS" ], "Ethnicities":[ "HispanicOrLatino" ], "MaritalStatus":"Single" }

Sample Response

{  
   "DegreePlanId":160,
   "ProgramIds":[  
      "BS.CIS"
   ],
   "StudentRestrictionIds":[  
      "93002",
      "148510",
      "133847",
      "123706",
      "127558",
      "114314",
      "107577",
      "92330",
      "85970",
      "85730"
   ],
   "HasAdvisor":true,
   "PreferredEmailAddress":"student@university.edu",
   "IsLegacyStudent":false,
   "IsFirstGenerationStudent":null,
   "IsInternationalStudent":false,
   "AdmitTerms":[  
      "14/U1"
   ],
   "AcademicLevelCodes":[  
      "UG"
   ],
   "ResidencyStatus":"RESIDENT",
   "HighSchoolGpas":[  
      {  
         "HighSchoolId":"0163328",
         "Gpa":2.3,
         "LastAttendedYear":"2014"
      }
   ],
   "Advisements":[  
      {  
         "AdvisorId":"0361012",
         "StartDate":"2016-08-03T00:00:00",
         "EndDate":null,
         "AdvisorType":"MAJOR"
      }
   ],
   "StudentTypeCode":"UG",
   "ClassLevelCodes":[  
      "JR"
   ],
   "IsConfidential":false,
   "AdvisorIds":[  
      "0361012"
   ],
   "IsTransfer":false,
   "FinancialAidCounselorId":null,
   "EmailAddresses":[  
      {  
         "Value":"student@university.edu",
         "TypeCode":"CC",
         "IsPreferred":true
      },
      {  
         "Value":"example.student@gmail.com",
         "TypeCode":"PR1",
         "IsPreferred":false
      }
   ],
   "StudentHomeLocations":[  

   ],
   "Id":"0475525",
   "LastName":"Student",
   "FirstName":"Ima",
   "MiddleName":"A",
   "BirthNameLast":null,
   "BirthNameFirst":null,
   "BirthNameMiddle":null,
   "PreferredName":"Ms. Ima A. Student",
   "PreferredAddress":[  
      "1446 Washington Ave",
      "Apt. 15",
      "Bronx, NY 10461"
   ],
   "Prefix":"Ms.",
   "Suffix":"",
   "Gender":"F",
   "BirthDate":"1996-04-29T00:00:00",
   "GovernmentId":"123-45-6789",
   "RaceCodes":[  

   ],
   "EthnicCodes":[  
      "HIS"
   ],
   "Ethnicities":[  
      "HispanicOrLatino"
   ],
   "MaritalStatus":"Single"
}

Sample Request
colleagueapi/advisors/{id}

Sample Response
{ "Id":"0361012", "LastName":"King", "FirstName":"Donna", "MiddleName":"", "EmailAddresses":[ "Donna.King@university.edu" ] }

Offline Functionality

Not supported.

Configuration Options

Configuration Item	Option
Display Items	Allow institutions to display or hide items in the advisor integration. Advisor type Advisor location Advisor phone Advisor email
Limit advisor type	Allow institutions to only display designated advisor type. If a user has multiple advisors with different advisor types, the service will only display information for the advisor with the designated type.
Advisor photo	Allow institutions to display the advisor's picture. Institutions who select this option will need to provide a database view.

Configuration Item

Option

Display Items

Allow institutions to display or hide items in the advisor integration.

Advisor type
Advisor location
Advisor phone
Advisor email

Limit advisor type

Allow institutions to only display designated advisor type. If a user has multiple advisors with different advisor types, the service will only display information for the advisor with the designated type.

Advisor photo

Allow institutions to display the advisor's picture. Institutions who select this option will need to provide a database view.

Labels

Label	Default Value
Tile name on home screen	My Advisor

Suggested Testing Guidelines

The following acceptance criteria is recommend to be used as part of the testing and approval process:

User can access the ‘My Advisor’ tile and see their advisor/key contact details