University of Illinois System

PersonLookupSearch

Service Information:

Version: 1.0

Availability: Production

Release Date: March 2022

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, NetId, FirstName or LastName.  Name search can include a wildcard and will be limited to 100 rows.

Source System: Banner

Operations:

 GET https://webservices.admin.uillinois.edu/personWS/data/{senderAppId}/PersonLookupSearch/1_0/{searchKey}?format={format}

A table detailing the parameter set for a Directory Data GET request.
Parameter Description Type Required
senderAppId Authorized sender application ID. String Yes
searchKey Query can be called with the UIN,  NetID, FirstName or LastName String

Yes
format Desired response format. Supports either "json" (default) or "xml". String No

 

Sample Request

 

GET /personWS/data/mySenderAppId/PersonLookupSearch/1_0/123456789?format=json HTTP/1.1  or
GET /personWS/data/mySenderAppId/PersonLookupSearch/1_0/jdoe?format=json HTTP/1.1
Host: webservices-dev.admin.uillinois.edu

Sample Response

 

employee will return the below:
{
    "Object": "PersonLookupSearch",
    "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": "PersonLookupSearch",
    "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: PersonLookupSearch

Version: 1.0

Element Map:

A table detailing the attributes and elements within the Directory Data object
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.  
personLookupSearch.uin Element uin Zero or One University Identification Number SPRIDEN_ID
personLookupSearch.name Object-Array name Zero or Many Child object containing all name attributes  
personLookupSearch.person.firstName Element firstName Zero or One First Name SPBPERS_PREF_FIRST_NAME then SPRIDEN_FIRST_NAME
personLookupSearch.person.lastName Element lastName Zero or One Last Name SPRIDEN_LAST_NAME
personLookupSearch.person.middleName Element middleName Zero or One Middle Name SPRIDEN_MI
personLookupSearch.netIds Object-Array netIDs Zero or Many Child object containing netid attributes  
personLookupSearch.netIds.netId Element netID Zero or One University ID associated with a user UILLINOIS.T_IDENTITY_NETID.IDENTITY_NETID
personLookupSearch.netIds.campusDomain Element campusDomain Zero or One Campus Domain UILLINOIS.T_IDENTITY_NETID.CAMPUS_DOMAIN
personLookupSearch.email Object-Array email addresses Zero or Many Child object containing email attributes  
personLookupSearch.email.emailAddress Element email address Zero or one UI active preferred email address GOREMAL.GOREMAL_EMAIL_ADDRESS
personLookupSearch.address Object-Array address Zero or Many Child object containing all active address-level attributes.  
personLookupSearch.address Element guid Zero or One Globally unique identifier from source system. SPRADDR_SURROGATE_ID
personLookupSearch.address.streetLine1 Element streetLine1 Zero or One The first line of the address associated with a person or entity. SPRADDR_STREET_LINE1
personLookupSearch.address.streetLine2 Element streetLIne2 Zero or One The second line of the address associated a with person or entity. SPRADDR_STREET_LINE2
personLookupSearch.address.streetLine3 Element streetLine3 Zero or One The third line of the address associated with a person or entity. SPRADDR_STREET_LINE3
personLookupSearch.address.city Element city Zero or One The city associated with the address of a person or entity. SPRADDR_CITY
personLookupSearch.address.state Object-Array state Zero or Many Child object containing the state attributes for an address STVSTAT_DESC
personLookupSearch.address.code Element stateCode Zero or One The state or province associated with the address of a person or entity. SPRADDR_STAT_CD
personLookupSearch.address.description Element description Zero or One description of state  
personLookupSearch.address.zipCode Element zipCode Zero or One The postal (zip) code associated with the address of a person or entity. SPRADDR_ZIP
personLookupSearch.phone Object-Array phone Zero or Many Child object containing campus phone-related attributes for a person or entity.  
personLookupSearch.phone.areaCode Element areaCode Zero or One Telephone number area code. SPRTELE_PHONE_AREA
personLookupSearch.phone.phoneNumber Element phoneNumber Zero or One Telephone number. SPRTELE_PHONE_NUMBER
personLookupSearch.title Element title Zero or One Primary Title NBRJOBS_DESC
personLookupSearch.employee Object employee Zero or Many Child object containing all active employee-related attributes for a person.  
personLookupSearch.employee.chartOfAccountsCode Element chartOfAccountsCode Zero or One The Home Chart of Accounts Code for the employee. PEBEMPL_COAS_CODE_HOME
personLookupSearch.employee.organizationCode Element organizationCode Zero or One The Home Organization code of the employee. PEBEMPL_ORGN_CODE_HOME
personLookupSearch.employee.organizationDesc Element organizationDesc Zero or One Description of the home organization code of the employee FTVORGN_TITLE
personLookupSearch.employee.employeeClass Element employeeClass Zero or One The employee grouping to which the employee belongs. (Valid per PTRECLS) PEBEMPL_ECLS_CODE