University of Illinois System

DirectoryData

Service Information:

Version: 1.0

Availability: Production

Release Date: January 2017

Framework: AITS RESTful Data API

Description: Query basic directory 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.

Source System: Banner

Operations:

 GET https://webservices.admin.uillinois.edu/personWS/data/{senderAppId}/DirectoryData/1_0/{institutionalId}?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
institutionalId University Identification Number (UIN) for subject to be queried. String Yes
format Desired response format. Supports either "json" (default) or "xml". String No

 

Sample Request

 

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

Sample Response

 

{
    "Object": "DirectoryData",
    "Version": "1_0",
    "list": [{
        "person": {
            "guid": 2309479,
            "pidm": 123456,
            "uin": "123456789",
            "lastName": "Doe",
            "firstName": "Jane"
        },
        "address": [
            {
                "guid": 6667230,
                "pidm": 123456,
                "type": "BI",
                "sequenceNum": 2,
                "streetLine1": "123 Main",
                "city": "Anytown",
                "stateCode": "IL"
            },
            {
                "guid": 7925686,
                "pidm": 123456,
                "type": "C1",
                "sequenceNum": 5,
                "streetLine1": "University Headquarters",
                "streetLine2": "Wright Street",
                "streetLine3": "M/C  1000",
                "city": "UIUC Campus Mail",
                "stateCode": "IL"
            }
        ],
        "email": [
            {
                "guid": 2167774,
                "pidm": 123456,
                "emailCode": "PERS",
                "emailAddress": "jdoe@google.com.test",
                "statusInd": "A",
                "preferredInd": "N"
            },
            {
                "guid": 789436,
                "pidm": 123456,
                "emailCode": "UI",
                "emailAddress": "jdoe@illinois.edu.test",
                "statusInd": "A",
                "preferredInd": "Y"
            }
        ],
        "phone": [{
            "guid": 6133092,
            "pidm": 123456,
            "type": "C1",
            "sequenceNum": 16,
            "areaCode": "217",
            "phoneNumber": "5553333",
            "linkedAddressType": "C1",
            "linkedAddressSequence": 5,
            "primaryInd": "Y"
        }],
        "employee": {
            "guid": 98765,
            "pidm": 123456,
            "employeeStatus": "A",
            "campusCode": "U",
            "chartOfAccountsCode": "9",
            "organizationCode": "654321",
            "organizationDesc": "Some University Org",
            "employeeClass": "BA",
            "title": "System Analyst"
        }
    }]
}

Data Object Detail:

Functional Area: Person

Name: DirectoryData

Version: 1.0

Element Map:

A table detailing the attributes and elements within the Directory Data object
Path Type Name Occurrence Description Authority
list or DirectoryDataList Object-Array list or DirectoryDataList Exactly One Directory level contact and affiliation data for university persons that have not requested suppression of this data. Standard name is "list", while some clients are provisioned to receive "DirectoryDataList" as the top-level array.  
DirectoryData.person Object person Zero or One Child object containing all person-level attributes, for an active person or entity, where not designated as confidential.  
DirectoryData.person.guid Element guid Exactly One Globally unique identifier from source system. SPRIDEN_SURROGATE_ID
DirectoryData.person.pidm Element pidm Zero or One Internal person identifier from Banner SPRIDEN_PIDM
DirectoryData.person.uin Element uin Zero or One University Identification Number SPRIDEN_ID
DirectoryData.person.lastName Element lastName Zero or One Last Name SPRIDEN_LAST_NAME
DirectoryData.person.firstName Element firstName Zero or One First Name SPBPERS_PREF_FIRST_NAME then SPRIDEN_FIRST_NAME
DirectoryData.address Object-Array address Zero or Many Child object containing all active address-level attributes.  
DirectoryData.address.guid Element guid Zero or One Globally unique identifier from source system. SPRADDR_SURROGATE_ID
DirectoryData.address.pidm Element pidm Zero or One Internal person identifier from Banner SPRADDR_PIDM
DirectoryData.address.type Element type Zero or One Address Type (valid per STVATYP) SPRADDR_ATYP_CODE
DirectoryData.address.seqenceNum Element sequenceNum Zero or One Internal sequence number for each address type associated with person. The maximum sequence represents the latest entered data for a given address type. SPRADDR_SEQNO
DirectoryData.address.streetLine1 Element streetLine1 Zero or One The first line of the address associated with a person or entity. SPRADDR_STREET_LINE1
DirectoryData.address.streetLine2 Element streetLIne2 Zero or One The second line of the address associated a with person or entity. SPRADDR_STREET_LINE2
DirectoryData.address.streetLine3 Element streetLine3 Zero or One The third line of the address associated with a person or entity. SPRADDR_STREET_LINE3
DirectoryData.address.city Element city Zero or One The city associated with the address of a person or entity. SPRADDR_CITY
DirectoryData.address.stateCode Element stateCode Zero or One The state or province associated with the address of a person or entity. SPRADDR_STAT_CD
DirectoryData.address.zipCode Element zipCode Zero or One The postal (zip) code associated with the address of a person or entity. SPRADDR_ZIP
DirectoryData.email Object-Array email Zero or Many Child object containing all active email-related attributes  
DirectoryData.email.guid Element guid Zero or One Globally unique identifier from source system. GOREMAL_SURROGATE_ID
DirectoryData.email.pidm Element pidm Zero or One Internal person identifier from Banner GOREMAL_PIDM
DirectoryData.email.emailCode Element emailCode Zero or One Email type (valid per GTVEMAL) GOREMAL_EMAL_CODE
DirectoryData.email.emailAddress Element emailAddress Zero or One Email address GOREMAL_EMAIL_ADDRESS
DirectoryData.email.statusInd Element statusInd Zero or One Email address status ("A" = Active; "I" = Inactive) GOREMAL_STATUS_IND
DirectoryData.email.preferredInd Element preferredInd Zero or One Preferred email indicator ("Y" = Yes; "N" = No) GOREMAL_PREFERRED_IND
DirectoryData.phone Object-Array phone Zero or Many Child object containing all active phone-related attributes for a person or entity.  
DirectoryData.phone.guid Element guid Zero or One Globally unique identifier from source system. SPRTELE_SURROGATE_ID
DirectoryData.phone.pidm Element pidm Zero or One Internal person identifier from Banner SPRTELE_PIDM
DirectoryData.phone.type Element type Zero or One Telephone type code (valid per STVTELE) SPRTELE_TELE_CODE
DirectoryData.phone.sequenceNum Element sequenceNum Zero or One Unique sequence number for telephone numbers associated with a person. The maximum sequence represents the latest entered data. SPRTELE_SEQNO
DirectoryData.phone.areaCode Element areaCode Zero or One Telephone number area code. SPRTELE_PHONE_AREA
DirectoryData.phone.phoneNumber Element phoneNumber Zero or One Telephone number. SPRTELE_PHONE_NUMBER
DirectoryData.phone.linkedAddressType Element linkedAddressType Zero or One Optional Address Type code associated with telephone number. SPRTELE_ATYP_CODE
DirectoryData.phone.linkedAddressSequence Element linkedAddressSequence Zero or One Address type sequence number associated with address type. SPRTELE_ADDR_SEQNO
DirectoryData.phone.primaryInd Element primaryInd Zero or One Primary indicator to denote primary telephone numbers based on telephone types (NULL = No; "Y" = Yes) SPRTELE_PRIMARY_IND
DirectoryData.phone.internationalAccessCode Element internationalAccessCode Zero or One Free format International access code for telephone number including country and city code. SPRTELE_INTL_ACCESS
DirectoryData.phone.countryCode Element countryCode Zero or One Telephone code that designates the region and country. SPRTELE_CTRY_CODE_PHONE
DirectoryData.employee Object employee Zero or Many Child object containing all active employee-related attributes for a person.  
DirectoryData.employee.guid Element guid Zero or One Globally unique identifier from source system. PEBEMPL_SURROGATE_ID
DirectoryData.employee.pidm Element pidm Zero or One Internal person identifier from Banner PEBEMPL_PIDM
DirectoryData.employee.employeeStatus Element employeeStatus Zero or One

The status of the employee ("A" = Active; "B" = Leave without pay and with benefits; "L" = Leave without pay and without benefits; "F" = Leave with pay and with benefits; "P" = Leave with partial pay and with benefits; "T" = Terminated)

 PEBEMPL_EMPL_STATUS
DirectoryData.employee.campusCode Element campusCode Zero or One Employee's physical campus location ("C" = Chicago; "S" = Springfield; "U" = Urbana) PEBEMPL_DICD_CODE
DirectoryData.employee.chartOfAccountsCode Element chartOfAccountsCode Zero or One The Home Chart of Accounts Code for the employee. PEBEMPL_COAS_CODE_HOME
DirectoryData.employee.organizationCode Element organizationCode Zero or One The Home Organization code of the employee. PEBEMPL_ORGN_CODE_HOME
DirectoryData.employee.organizationDesc Element organizationDesc Zero or One Description of the home organization code of the employee FTVORGN_TITLE
DirectoryData.employee.employeeClass Element employeeClass Zero or One The employee grouping to which the employee belongs. (Valid per PTRECLS) PEBEMPL_ECLS_CODE
DirectoryData.employee.title Element title Zero or One Description of the job NBRJOBS_DESC