Ellucian Colleague - Personal Details - 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 default tile design is detailed in the table below. The tile size and design can be modified according to the institution branding guidelines.

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

Screenshots

Sample Requests

To enable the personal details services the following request and responses are supported.

Sample Request
colleagueapi/persons/{personId}

Sample Response
{ "Id":"0475525", "LastName":"Student", "FirstName":"Ima", "PreferredName":"Ms. Ima A. Student", "BirthDate":"1996-04-07T00:00:00", "PreferredEmailAddress":"student@university.edu", "Addresses":[ { "AddressId":"309242", "Type":"Home", "AddressLines":[ "1446 Edwards Ave", "Apt. 2" ], "AddressModifier":"", "City":"Bronx", "State":"NY", "PostalCode":"10461", "County":"", "Country":"", "RouteCode":"", "PhoneNumbers":[ { "Number":"9174559936 ", "Extension":"", "TypeCode":"HOME" }, { "Number":" ", "Extension":"", "TypeCode":"CELL" } ], "AddressLabel":[ "1446 Washington Ave", "Apt. 15", "Bronx, NY 10461" ], "PersonId":"0474425", "EffectiveStartDate":"2015-02-25T00:00:00", "EffectiveEndDate":null, "IsPreferredAddress":true, "IsPreferredResidence":true, "TypeCode":"H", "CountryCode":"" } ], "EmailAddresses":[ { "Value":"student@university.edu", "TypeCode":"CC", "IsPreferred":true }, { "Value":"student.example@gmail.com", "TypeCode":"PR1", "IsPreferred":false } ], "Phones":[ { "Number":"9178675309 ", "Extension":"", "TypeCode":"HOME" }, { "Number":" ", "Extension":"", "TypeCode":"CELL" } ], "AddressConfirmationDateTime":null, "EmailAddressConfirmationDateTime":null, "PhoneConfirmationDateTime":null, "LastChangedDateTime":"2017-10-31T21:34:57Z" }

Sample Response

{  
   "Id":"0475525",
   "LastName":"Student",
   "FirstName":"Ima",
   "PreferredName":"Ms. Ima A. Student",
   "BirthDate":"1996-04-07T00:00:00",
   "PreferredEmailAddress":"student@university.edu",
   "Addresses":[  
      {  
         "AddressId":"309242",
         "Type":"Home",
         "AddressLines":[  
            "1446 Edwards Ave",
            "Apt. 2"
         ],
         "AddressModifier":"",
         "City":"Bronx",
         "State":"NY",
         "PostalCode":"10461",
         "County":"",
         "Country":"",
         "RouteCode":"",
         "PhoneNumbers":[  
            {  
               "Number":"9174559936          ",
               "Extension":"",
               "TypeCode":"HOME"
            },
            {  
               "Number":"                    ",
               "Extension":"",
               "TypeCode":"CELL"
            }
         ],
         "AddressLabel":[  
            "1446 Washington Ave",
            "Apt. 15",
            "Bronx, NY 10461"
         ],
         "PersonId":"0474425",
         "EffectiveStartDate":"2015-02-25T00:00:00",
         "EffectiveEndDate":null,
         "IsPreferredAddress":true,
         "IsPreferredResidence":true,
         "TypeCode":"H",
         "CountryCode":""
      }
   ],
   "EmailAddresses":[  
      {  
         "Value":"student@university.edu",
         "TypeCode":"CC",
         "IsPreferred":true
      },
      {  
         "Value":"student.example@gmail.com",
         "TypeCode":"PR1",
         "IsPreferred":false
      }
   ],
   "Phones":[  
      {  
         "Number":"9178675309          ",
         "Extension":"",
         "TypeCode":"HOME"
      },
      {  
         "Number":"                    ",
         "Extension":"",
         "TypeCode":"CELL"
      }
   ],
   "AddressConfirmationDateTime":null,
   "EmailAddressConfirmationDateTime":null,
   "PhoneConfirmationDateTime":null,
   "LastChangedDateTime":"2017-10-31T21:34:57Z"
}

Offline Functionality

Not supported.

Configuration Options

Labels

Label	Default Value
Tile name on home screen	Personal Details
Tile screen title	Personal Details
Screen header	Contact Information

Suggested Testing Guidelines

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

User can access the Personal Details Tile and see their contact information