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.
deptCode
PPS deptcode - refers to PPS work department. (The primary department the employee works for.)
deptOfficialName
PPS department name
deptDisplayName
PPS department display name
deptAbbrev
PPS department abbreviation
isUCDHS
true/false, is the department an UCDHS department
bouOrgOId
Unique IAM guid(global unique ID) for the parent BOU (Business Operating Unit) department
adminDeptCode
PPS admin deptcode - refers to the PPS admin department. (The primary department the employee is paid by and administered by.)
adminDeptOfficialName
PPS admin department name
adminDeptDisplayName
PPS admin department display name
adminDeptAbbrev
PPS admin department abbreviation
adminIsUCDHS
true/false, is the admin department an UCDHS department
adminBouOrgOId
Unique IAM guid(global unique ID) for the admin department's parent BOU (Business Operating Unit) department.
apptDeptCode
PPS appointment deptcode - refers to the PPS appointment department. (Returns the individual appointment departments for employees with multiple PPS appointments.)
apptDeptOfficialName
PPS appointment department name
apptDeptDisplayName
PPS appointment department display name
apptDeptAbbrev
PPS appointment department abbreviation
apptIsUCDHS
true/false, is the appointment department an UCDHS department
bouOrgOId
apptBouOrgOId
Unique IAM guid(global unique ID) for the appointment department's parent BOU (Business Operating Unit) department.
assocRank
For individuals with multiple associations, this ranks them by titlecode.
assocStartDate
Reported start date for the association
assocEndDate
Reported end date for the association
titleCode
PPS titlecode
titleOfficialName
PPS title name
titleDisplayName
PPS title display name
positionTypeCode
PPS position type code
positionType
PPS position type description
percentFullTime
The percent fulltime the individual is required to work for this association.
createDate
The date this association was created in the IAM system
modifyDate
The last date this association was modified in the IAM system
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.