PersonData

Service Information:

Version: 1.0

Availability: Production

Release Date: July 2020

Framework: AITS RESTful Data API

Description: Person data about a university affiliate.

Source System: Banner

Operations:

GET https://webservices.admin.uillinois.edu/personWS/data/{senderAppId}/PersonData/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/PersonData/1_0/123456789?format=json HTTP/1.1
Host: webservices-dev.admin.uillinois.edu

Sample Response

{
    "Object": "PersonData",
    "Version": "1_0",
    "list": [
        {
            "identity": {
                "guid": 2309479,
                "pidm": 123456,
                "uin": "123456789"
            },
            "names": [
                {
                    "pidm": 123456,
                    "uin": "123456789",
                    "type": "LEGAL",
                    "firstName": "Joseph",
                    "middleName": "Mike",
                    "lastName": "Smith"
                },
                {
                    "pidm": 123456,
                    "uin": "123456789",
                    "type": "PREF",
                    "firstName": "Joe",
                    "lastName": "Smith"
                }
            ],
            "biodemo": {
                "guid": 2309479,
                "pidm": 123456,
                "activityDate": "2020-07-08",
                "dataOrigin": "AITS_WS_personWS",
                "userId": "UI2JWSAITSWS",
                "birthDate": "1973-11-20",
                "citzCode": "US",
                "citzInd": "Y",
                "gender": "M",
                "armedForcesServiceMedal": "N"
            },
            "address": [
                {
                    "guid": 6667230,
                    "pidm": 123456,
                    "fromDate": "2019-01-01",
                    "toDate": "2020-07-08",
                    "activityDate": "2020-07-30",
                    "statusInd": "I",
                    "type": {
                        "code": "C1",
                        "description": "Campus Primary"
                    },
                    "sequenceNum": 2,
                    "streetLine1": "123 Main",
                    "city": "Anytown",
                    "stateCode": {
                        "code": "IL",
                        "description": "Illinois"
                    },
                    "zipCode": "00000",
                    "effectiveStatus": "I"
                },
                {
                    "guid": 3970460,
                    "pidm": 123456,
                    "fromDate": "2007-02-05",
                    "activityDate": "2007-02-05",
                    "type": {
                        "code": "C1",
                        "description": "Campus Primary"
                    },
                    "sequenceNum": 2,
                    "streetLine1": "01 Gerty Drive",
                    "streetLine3": "M/C  123",
                    "city": "UIUC Campus Mail",
                    "state": {
                        "code": "IL",
                        "description": "Illinois"
                    },
                    "zipCode": "00001",
                    "effectiveStatus": "A",
                    "phone": [
                        {
                            "guid": 1649420,
                            "pidm": 123456,
                            "sequenceNum": 1,
                            "type": {
                                "code": "C1",
                                "description": "Campus Phone 1"
                            },
                            "activityDate": "2007-02-05",
                            "linkedAddressType": {
                                "code": "C1",
                                "description": "Campus Primary"
                            },
                            "linkedAddressSequence": 2,
                            "areaCode": "217",
                            "phoneNumber": "3333333",
                            "primaryInd": "Y",
                            "effectiveStatus": "A"
                        }
                    ],
                    "email": [
                        {
                            "guid": 5443333,
                            "pidm": 123456,
                            "activityDate": "2020-07-14",
                            "emailCode": "PERS",
                            "emailAddress": "joesmith@gmail.com",
                            "statusInd": "I",
                            "preferredInd": "N",
                            "displayWebInd": "N",
                            "dataOrigin": "AITS_WS_personWS",
                            "effectiveStatus": "I"
                        },
                        {
                            "guid": 5443436,
                            "pidm": 123456,
                            "activityDate": "2020-07-17",
                            "emailCode": "UI",
                            "emailAddress": "jsmith@uillinois.edu",
                            "statusInd": "A",
                            "preferredInd": "Y",
                            "displayWebInd": "&",
                            "dataOrigin": "AITS_WS_personWS",
                            "effectiveStatus": "A"
                        }
                    ],
                    "employee": {
                        "guid": 654321,
                        "pidm": 123456,
                        "employeeStatus": "A",
                        "campusCode": "U",
                        "chartOfAccountsCode": "9",
                        "organizationCode": "654321",
                        "organizationDesc": "Some University Org",
                        "employeeClass": "BA"
                    }
                }
            ]
        }
    ]
}

Data Object Detail:

Functional Area: Person

Name: PersonData

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. Standard name is "list"
PersonData.identity	Object	identity	Zero or One	Child object containing all idenity-level attributes, for an active person, where not designated as confidential.
PersonData.identity.guid	Element	guid	Exactly One	Globally unique identifier from source system.	SPRIDEN_SURROGATE_ID
PersonData.identity.pidm	Element	pidm	Zero or One	Internal person identifier from Banner	SPRIDEN_PIDM
PersonData.identity.uin	Element	uin	Zero or One	University Identification Number	SPRIDEN_ID
PersonData.names	Object	names	Zero or many	Child object containing all name attributes, for an active person, where not designated as confidential.
PersonData.names.pidm	Element	pidm	Zero or One	Internal person identifier from Banner	SPRIDEN_PIDM
PersonData.names.uin	Element	uin	Zero or One	University Identification Number	SPRIDEN_ID
PersonData.names.type	Element	type	Zero or One	Name Type	SPRIDEN_NTYP_CODE
PersonData.names.firstName	Element	firstName	Zero or One	First Name	SPRIDEN_FIRST_NAME
PersonData.names.middleName	Element	middleName	Zero or One	Middle Name	SPRIDEN_MI
PersonData.names.lastName	Element	lastName	Zero or One	Last Name	SPRIDEN_LAST_NAME
PersonData.biodemo	Object-Array	address	Zero or Many	Child object containing all demographic attributes.
PersonData.biodemo.guid	Element	guid	Zero or One	Globally unique identifier from source system.	SPBPERS_SURROGATE_ID
PersonData.biodemo.pidm	Element	pidm	Zero or One	Internal person identifier from Banner	SPBPERS_PIDM
PersonData.biodemo.activityDate	Element	activity date	Zero or One	This field defines the most current date a record is added or changed	SPBPERS_ACTIVITY_DATE
PersonData.biodemo.dataOrigin	Element	data origin	Zero or One	Source system that created or updated the row	SPBPERS_DATA_ORIGIN
PersonData.biodemo.userId	Element	user ID	Zero or One	User ID	SPBPERS_USER_ID
PersonData.biodemo.birthDate	Element	birthdate	Zero or One	The persons birthdate	SPBPERS_BIRTH_DATE
PersonData.biodemo.citzCode	Element	Citz Code	Zero or One	Users citizen code	SPBPERS_CITZ_CODE
PersonData.biodemo.citzInd	Element	Citz Ind	Zero or One	Users citizen indicator	SPBPERS_CITZ_IND
PersonData.biodemo.gender	Element	gender	Zero or One	gender M - Male, F - Female, N - Unknown	SPBPERS_SEX
PersonData.biodemo.armedForcesServiceMedal	Element	aremed forces service medal	Zero or One	Armed Forces Service Medal Indicator	SPBPERS_ARMED_SERV_MED_VET_IND
PersonData.address	Object-Array	address	Zero or Many	Child object containing all active address-level attributes.
PersonData.address.guid	Element	guid	Zero or One	Globally unique identifier from source system.	SPRADDR_SURROGATE_ID
PersonData.address.pidm	Element	pidm	Zero or One	Internal person identifier from Banner	SPRADDR_PIDM
PersonData.address.fromDate	Element	fromDate	Zero or One	The effective start date of address associated with person	SPRADDR_FROM_DATE
PersonData.address.toDate	Element	toDate	Zero or One	The effective end date of address associated with person	SPRADDR_END_DATE
PersonData.address.activityDate	Element	activityDate	Zero or One	The most current date a record is added or changed	SPRADDR_ACTIVITY_DATE
PersonData.address.statusInd	Element	StatusInd	Zero or One	identifies if address information is inactive. Valid value is I - Inactive.	SPRADDR_STATUS_IND
PersonData.address.type	Object-Array	type	Zero or Many	Child object containing address type and description.
PersonData.address.type.code	Element	code	Zero or One	Identifies the type of address associated with person	SPRADDR_ATYP_CODE
PersonData.address.type.description	Element	code	Zero or One	Description of the address type code	STVATYP_DESC
PersonData.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
PersonData.address.streetLine1	Element	streetLine1	Zero or One	The first line of the address associated with a person or entity.	SPRADDR_STREET_LINE1
PersonData.address.streetLine2	Element	streetLIne2	Zero or One	The second line of the address associated a with person or entity.	SPRADDR_STREET_LINE2
PersonData.address.streetLine3	Element	streetLine3	Zero or One	The third line of the address associated with a person or entity.	SPRADDR_STREET_LINE3
PersonData.address.city	Element	city	Zero or One	The city associated with the address of a person or entity.	SPRADDR_CITY
PersonData.address.state	Object-Array	state	Zero or Many	Child object containing address type and description.
PersonData.address.state.code	Element	stateCode	Zero or One	The state or province associated with the address of a person or entity.	SPRADDR_STAT_CD
PersonData.address.state.description	Element	stateCode	Zero or One	The state or province associated with the address of a person or entity.	STVSTAT_DESC
PersonData.address.zipCode	Element	zipCode	Zero or One	The postal (zip) code associated with the address of a person or entity.	SPRADDR_ZIP
PersonData.address.effectiveStatus	Element	EffectiveStatus	Zero or One	Derived status indicator
PersonData.address.phone	Object-Array	phone	Zero or Many	Child object containing all active phone-related attributes for a person or entity.
PersonData.address.phone.guid	Element	guid	Zero or One	Globally unique identifier from source system.	SPRTELE_SURROGATE_ID
PersonData.address.phone.pidm	Element	pidm	Zero or One	Internal person identifier from Banner	SPRTELE_PIDM
PersonData.address.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
PersonData.address.phone.type	Object-Array	phone	Zero or Many	Identifies the type of phone associated with person
PersonData.address.phone.type.code	Element	PhoneTypecode	Zero or One	Identifies the type of phone associated with person	SPRTELE_TELE_CODE
PersonData.address.phone.type.description	Element	phone type description	Zero or One	The description associated with the phone type	STVTELE_DESC
PersonData.address.phone.activityDate	Element	Activity Date	Zero or One	The most current date a record is added or changed	SPRTELE_ACTIVITY_DATE
PersonData.address.phone.linkedAddressType	Object-Array	phone	Zero or Many	Identifies the address associated with phone record for person
PersonData.address.phone.linkedAddressType.code	Element	PhoneTypecode	Zero or One	Identifies the type of address associated with person	SPRTELE_ATYP_CODE
PersonData.address.phone.linkedAddressType.description	Element	phone type description	Zero or One	The description associated with the address type	STVATYP_DESC
PersonData.address.phone.linkedAddressSequence	Element	linkedAddressSequence	Zero or One	Address type sequence number associated with address type.	SPRTELE_ADDR_SEQNO
PersonData.address.phone.areaCode	Element	areaCode	Zero or One	Telephone number area code.	SPRTELE_PHONE_AREA
PersonData.address.phone.phoneNumber	Element	phoneNumber	Zero or One	Telephone number.	SPRTELE_PHONE_NUMBER
PersonData.address.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
PersonData.address.phone.effectiveStatus	Element	effectiveStatus	Zero or One	derived value to determine the status
PersonData.address.phone.internationalAccessCode	Element	internationalAccessCode	Zero or One	Free format International access code for telephone number including country and city code.	SPRTELE_INTL_ACCESS
PersonData.address..phone.countryCode	Element	countryCode	Zero or One	Telephone code that designates the region and country.	SPRTELE_CTRY_CODE_PHONE
PersonData.email	Object-Array	email	Zero or Many	Child object containing all active email-related attributes
PersonData.email.guid	Element	guid	Zero or One	Globally unique identifier from source system.	GOREMAL_SURROGATE_ID
PersonData.email.pidm	Element	pidm	Zero or One	Internal person identifier from Banner	GOREMAL_PIDM
PersonData.email.activityDate	Element	activityDate	Zero or One	Date of last activity for email record	GOREMAL_ACTIVITY_DATE
PersonData.email.emailCode	Element	emailCode	Zero or One	Email type (valid per GTVEMAL)	GOREMAL_EMAL_CODE
PersonData.email.emailAddress	Element	emailAddress	Zero or One	Email address	GOREMAL_EMAIL_ADDRESS
PersonData.email.statusInd	Element	statusInd	Zero or One	Email address status ("A" = Active; "I" = Inactive)	GOREMAL_STATUS_IND
PersonData.email.preferredInd	Element	preferredInd	Zero or One	Preferred email indicator ("Y" = Yes; "N" = No)	GOREMAL_PREFERRED_IND
PersonData.email.displayWebInd	Element	preferredInd	Zero or One	Indicate whether a e-mail address should appear on Web	GOREMAL_DISP_WEB_IND
PersonData.email.dataOrigin	Element	preferredInd	Zero or One	Source system that created or updated the data	GOREMAL_DATA_ORIGIN
PersonData.email.effectiveStatus	Element	preferredInd	Zero or One	derived indicator
PersonData.employee	Object-Array	employee	Zero or Many	Child object containing all active employee-related attributes for a person.
PersonData.employee.guid	Element	pidm	Zero or One	Globally unique identifier from source system.	PEBEMPL_GUID
PersonData.employee.pidm	Element	pidm	Zero or One	Internal person identifier from Banner	PEBEMPL_PIDM
PersonData.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
PersonData.employee.retireeOrEmeritus	Element	retireeOrEmeritus	Zero or One	If pebempl_trea_code = 'TR' then true, else false
PersonData.employee.campusCode	Element	campusCode	Zero or One	Employee's physical campus location ("C" = Chicago; "S" = Springfield; "U" = Urbana)	PEBEMPL_DICD_CODE
PersonData.employee.chartOfAccountsCode	Element	chartOfAccountsCode	Zero or One	The Home Chart of Accounts Code for the employee.	PEBEMPL_COAS_CODE_HOME
PersonData.employee.organizationCode	Element	organizationCode	Zero or One	The Home Organization code of the employee.	PEBEMPL_ORGN_CODE_HOME
PersonData.employee.organizationDesc	Element	organizationDesc	Zero or One	Description of the home organization code of the employee	FTVORGN_TITLE
PersonData.employee.employeeClass	Element	employeeClass	Zero or One	The employee grouping to which the employee belongs. (Valid per PTRECLS)	PEBEMPL_ECLS_CODE