Versions Compared

Old Version 62

changes.mady.by.user Amina Mohamed

Saved on

compared with

New Version 63

changes.mady.by.user Nan Jiang

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.




Section


Column
width20%


Panel
borderColor#BF9900
bgColor#FFFFFF
titleBGColor#E5D699
borderStylesolid
titleIn this Section
Table of Contents
indent15px
stylenone




Column

Overview

API Requirements

Include Page
API Requirements
API Requirements

Getting Started

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.

Code Block
titleSample JSON Request
	curl -i -H "Accept: application/json" https://iet-ws.ucdavis.edu/api/iam/people/search?oFirstName=Gary&oLastName=Sharpe&key=myKey&v=1.0

The response to all of the above requests have a Content-Type of text/javascript.  An example response for the above request is shown below:

Code Block
langxml
titleSample JSON Response
{
"reponseData":{
"results":[
{
"iamId":"1000014336",
"mothraId":null,
"ppsId":null,
"employeeId": null,
"studentId":null,
"externalId":null,
"dFirstName":null,
"dFullName":" ",
"dLastName":null,
"dMiddleName":null,
"modifyDate":null,
"oFirstName":"GARY",
"oFullName":"GARY SHARPE",
"oLastName":"SHARPE",
"oMiddleName":null,
"bannerPIdM":null,
"oSuffix":null,
"dSuffix":null,
"dPronouns":null,
"isEmployee":true,
"isHSEmployee":false,
"isFaculty":false,
"isStudent":false,
"isStaff":true,
"isExternal":false,
"privacyCode":null
}
]},
"responseDetails":null,
"responseStatus":0
}

JSON Reference

Include Page
JSON Reference
JSON Reference

Request Format

URL Base Addresses

The following URL patterns are supported by the IAM Identity Store Core People API:

Code Block
langxml
titleSupported URL Patterns
https://iet-ws.ucdavis.edu/api/iam/people/{iamid}

https://iet-ws.ucdavis.edu/api/iam/people/search

URL Arguments

Include Page
URL Arguments
URL Arguments
Required URL Arguments 
Include Page
Required URL Arguments
Required URL Arguments
Other Supported URL arguments

Include Page
Supported URL Arguments
Supported URL Arguments

URL

Supported Arguments

https://iet-ws.ucdavis.edu/api/iam/people/search

oFirstName
oMiddleName
oLastName
dFirstName
dMiddleName
dLastName
mothraId
studentId
externalId
iamId
ppsId
employeeId
bannerPIdM


Response Format

Include Page
Response Format for IET-WS APIs
Response Format for IET-WS APIs

Results Array: Guaranteed Fields

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

 employeeId EmployeeID is 9 digit currently and will be converted to 11 digit for UCPath

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)

dPronounsDisplay Preferred Pronouns (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.

Response Codes and Messages

Include Page
Response Codes and Messages
Response Codes and Messages

Troubleshooting

Include Page
Troubleshooting IET-WS APIs
Troubleshooting IET-WS APIs


...