The easiest way to start learning about this interface is to try it out. This section shows how to use the curl command line tool to execute sample queries.
The results array always contains the parameters listed in this section, even if the value is empty.
Property
Description
iamId
Unique University ID created by IAM system. Replaces MOTHRAID.
mothraId
Legacy unique ID from mothra system.
ppsId
PPS employee ID
studentId
Banner student ID
bannerPIdM
Banner alternative ID for faculty/instructors and students
externalId
Unique ID from external systems
oFirstName
Official First Name
oMiddleName
Official Middle Name
oLastName
Official Last Name
oSuffix
Official Suffix
oFullName
Composite of O_[F/M/L]NAME
dFirstName
Display First Name (from Online Directory)
dMiddleName
Display Middle Name (from Online Directory)
dLastName
Display Last Name (from Online Directory)
dSuffix
Display Suffix (from Online Directory)
dFullName
Composite of D_[F/M/L]NAME
isEmployee
true/false, Does the person have an employee affiliation (either staff or faculty)
isHSEmployee
true/false, Does the person have an employee affiliation from the UCDHS
isFaculty
true/false, Does the person have a faculty affiliation
isStudent
true/false, Does the person have a student affiliation
isStaff
true/false, Does the person have a staff affiliation
isExternal
true/false, Does the person have an external affiliation
privacyCode
Privacy code that applies to this person (currently only FERPA from Banner)
modifyDate
Last date any attribute for this person was modified
results[]
results[] contains an array of bulk load result objects, one for each result. Each time the API executes, this property is cleared, and each time a API completes, the array is populated. If there are no results to report, the .length property of this array will be set to 0. Therefore, results will never be null, and you can always safely check for results.length == 0.