PersonLookup
Service Information:
Version: 1.0
Availability: Production
Release Date: September 2020
Framework: AITS RESTful Data API
Description: Query basic data for a university person. This service excludes anyone who has requested suppression of their directory information. Also excluded is any underlying data that has been designated as restricted/unlisted by those who have not suppressed their directory information otherwise. Searches can be done by UIN or NetId.
Source System: Banner
Operations:
GET https://webservices.admin.uillinois.edu/personWS/data/{senderAppId}/PersonLookup/1_0/{searchKey}?format={format}
| Parameter | Description | Type | Required |
|---|---|---|---|
| senderAppId | Authorized sender application ID. | String | Yes |
| searchKey | Query can be called with the UIN or the NetID | String | Yes |
| format | Desired response format. Supports either "json" (default) or "xml". | String | No |
Sample Request
GET /personWS/data/mySenderAppId/PersonLookup/1_0/123456789?format=json HTTP/1.1 or GET /personWS/data/mySenderAppId/PersonLookup/1_0/jdoe?format=json HTTP/1.1 Host: webservices-dev.admin.uillinois.edu
Sample Response
employee will return the below: { "Object": "PersonLookup", "Version": "1_0", "list": [{ "uin": "123456789", "name": { "firstName": "Jane", "laststName": "Doe", "middleName": "S" }, "netIds": [ { "netId": "jdoe", "campusDomain": "illinois.edu" }, { "netId": "jdoe", "campusDomain": "uillinois.edu" } ], "email": { "emailAddress": "jdoe@illinois.edu" }, "address": { "streetLine1": "University Headquarters", "streetLine2": "Wright Street", "streetLine3": "M/C 1000", "city": "UIUC Campus Mail", "state": { "code": "IL", "description": "Illinois" }, "zipcode": "00001" }, "phone": { "areaCode": "217", "phoneNumber": "5553333" }, "title": "Director Of Something", "employee": { "chartOfAccountsCode": "9", "organizationCode": "654321", "organizationDesc": "Some University Org", "employeeClass": "BA" } }] }
student will return the below: { "Object": "PersonLookup", "Version": "1_0", "list": [{ "uin": "123456789", "name": { "firstName": "Jane", "laststName": "Doe", "middleName": "S" }, "netIds": [ { "netId": "jdoe", "campusDomain": "illinois.edu" }, { "netId": "jdoe", "campusDomain": "uillinois.edu" } ], "email": { "emailAddress": "jdoe@illinois.edu" } } ] }
Data Object Detail:
Functional Area: Person
Name: PersonLookup
Version: 1.0
Element Map:
| Path | Type | Name | Occurrence | Description | Authority |
|---|---|---|---|---|---|
| list | Object-Array | list | Exactly One | Directory level contact and affiliation data for university persons that have not requested suppression of this data. | |
| personLookup.uin | Element | uin | Zero or One | University Identification Number | SPRIDEN_ID |
| personLookup.name | Object-Array | name | Zero or Many | Child object containing all name attributes | |
| personLookup.person.firstName | Element | firstName | Zero or One | First Name | SPBPERS_PREF_FIRST_NAME then SPRIDEN_FIRST_NAME |
| personLookup.person.lastName | Element | lastName | Zero or One | Last Name | SPRIDEN_LAST_NAME |
| personLookup.person.middleName | Element | middleName | Zero or One | Middle Name | SPRIDEN_MI |
| personLookup.netIds | Object-Array | netIDs | Zero or Many | Child object containing netid attributes | |
| personLookup.netIds.netId | Element | netID | Zero or One | University ID associated with a user | UILLINOIS.T_IDENTITY_NETID.IDENTITY_NETID |
| personLookup.netIds.campusDomain | Element | campusDomain | Zero or One | Campus Domain | UILLINOIS.T_IDENTITY_NETID.CAMPUS_DOMAIN |
| personLookup.email | Object-Array | email addresses | Zero or Many | Child object containing email attributes | |
| personLookup.email.emailAddress | Element | email address | Zero or one | UI active preferred email address | GOREMAL.GOREMAL_EMAIL_ADDRESS |
| personLookup.address | Object-Array | address | Zero or Many | Child object containing all active address-level attributes. | |
| personLookup.address | Element | guid | Zero or One | Globally unique identifier from source system. | SPRADDR_SURROGATE_ID |
| personLookup.address.streetLine1 | Element | streetLine1 | Zero or One | The first line of the address associated with a person or entity. | SPRADDR_STREET_LINE1 |
| personLookup.address.streetLine2 | Element | streetLIne2 | Zero or One | The second line of the address associated a with person or entity. | SPRADDR_STREET_LINE2 |
| personLookup.address.streetLine3 | Element | streetLine3 | Zero or One | The third line of the address associated with a person or entity. | SPRADDR_STREET_LINE3 |
| personLookup.address.city | Element | city | Zero or One | The city associated with the address of a person or entity. | SPRADDR_CITY |
| personLookup.address.state | Object-Array | state | Zero or Many | Child object containing the state attributes for an address | STVSTAT_DESC |
| personLookup.address.code | Element | stateCode | Zero or One | The state or province associated with the address of a person or entity. | SPRADDR_STAT_CD |
| personLookup.address.description | Element | description | Zero or One | description of state | |
| personLookup.address.zipCode | Element | zipCode | Zero or One | The postal (zip) code associated with the address of a person or entity. | SPRADDR_ZIP |
| personLookup.phone | Object-Array | phone | Zero or Many | Child object containing campus phone-related attributes for a person or entity. | |
| personLookup.phone.areaCode | Element | areaCode | Zero or One | Telephone number area code. | SPRTELE_PHONE_AREA |
| personLookup.phone.phoneNumber | Element | phoneNumber | Zero or One | Telephone number. | SPRTELE_PHONE_NUMBER |
| personLookup.title | Element | title | Zero or One | Primary Title | NBRJOBS_DESC |
| personLookup.employee | Object | employee | Zero or Many | Child object containing all active employee-related attributes for a person. | |
| personLookup.employee.chartOfAccountsCode | Element | chartOfAccountsCode | Zero or One | The Home Chart of Accounts Code for the employee. | PEBEMPL_COAS_CODE_HOME |
| personLookup.employee.organizationCode | Element | organizationCode | Zero or One | The Home Organization code of the employee. | PEBEMPL_ORGN_CODE_HOME |
| personLookup.employee.organizationDesc | Element | organizationDesc | Zero or One | Description of the home organization code of the employee | FTVORGN_TITLE |
| personLookup.employee.employeeClass | Element | employeeClass | Zero or One | The employee grouping to which the employee belongs. (Valid per PTRECLS) | PEBEMPL_ECLS_CODE |