Identity Store Core People API
Overview
API Requirements
Each request must provide a valid API Key. You may request your own API Key by emailing either iam-data-admin@ucdavis.edu or middleware-api@ucdavis.edu.
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.
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:
{
"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
Unlike the core JavaScript interface, the JSON interface is exposed through a uniform URL that contains CGI arguments. Your application can use an HTTP stack of its choosing. In order to use the JSON interface:
- You must construct a properly formatted URL with all necessary CGI arguments.
- You must send an HTTP referer header that accurately identifies your application.
- You must process the JSON-encoded response.
Request Format
URL Base Addresses
The following URL patterns are supported by the IAM Identity Store Core People API:
https://iet-ws.ucdavis.edu/api/iam/people/{iamid}
https://iet-ws.ucdavis.edu/api/iam/people/search
URL Arguments
This section describes the arguments that can be used for search requests.
The value of a CGI argument must always be properly escaped. This can be done via the functional equivalent of JavaScript's encodeURIComponent() method.
Required URL Arguments
The following table lists the required URL arguments.
Argument |
Example |
Description |
|---|---|---|
key |
key=your-key |
This argument supplies the application's key. You may request your own API Key by emailing either [mailto:iam-data-admin@ucdavis.edu] or [mailto:middleware-api@ucdavis.edu].It must be a valid key associated with your application. The key is required for this API to implement quality of service rules for this API. If your application is making too many requests it will be throttled to ensure resources are not overloaded during times of peak usage. Also, by supplying a key we can identify and contact you should something go wrong with your application. |
v |
v=1.0 |
This argument supplies protocol version number. The only valid value at this point in time is 1.0. |
Other Supported URL arguments
The following table lists the supported URL arguments for each supported URL pattern.
At least one argument should be provided to perform a search. If multiple search criteria are provided an 'AND' search will be performed to match on all arguments.
URL | Supported Arguments |
|---|---|
oFirstName |
Response Format
Each response follow this general format:
{
"responseData" : {
"results" : []
},
"responseDetails" : null | string-on-error,
"responseStatus" : 0 | error-code
}
In the JSON fragment above, note that the responseData property contains a results array and an optional cursor.
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 (Will be replaced with lived name in the next version release) |
oMiddleName | Official Middle Name (Will be replaced with lived name in the next version release) |
oLastName | Official Last Name (Will be replaced with lived name in the next version release) |
oSuffix | Official Suffix (Will be replaced with lived name in the next version release) |
oFullName | Composite of O_[F/M/L]NAME (Will be replaced with lived name in the next version release) |
dFirstName | Lived First Name (from Online Directory) |
dMiddleName | Lived Middle Name (from Online Directory) |
dLastName | Lived Last Name (from Online Directory) |
dSuffix | Lived Suffix (from Online Directory) |
| dPronouns | Lived Preferred Pronouns (from Online Directory) |
dFullName | Composite of Lived_[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
The table below contains a breakdown of the possible 'responseStatus' Codes and 'responseDetails' Messages
The responseStatus property contains a value of 0 on success and a custom error status code on failure. If there is a failure, responseDetails contains a diagnostic string.
Code (responseStatus) |
Message (responseDetails |
Description |
|---|---|---|
0 |
|
General Success. Request Processed and Results, if any, returned to client. |
1 |
Search returned no results. |
No results were found given the search criteria (NOTE: Not currently used in Identity Store APIs. This is used in the Mothra API.) |
2 |
Invalid API key. |
API key is invalid, or simply does not have the permission to view the requested API. |
3 |
The system encountered an error while processing this request. |
Generic system error. Details will have been captured on Identity Store API server logs. |
4 |
|
Data Error. (NOTE: Not currently used in Identity Store APIs. This is used in the Mothra API.) |
5 |
Missing search parameters (At least one parameter is required). |
|
Troubleshooting
If you encounter problems with your code:
- Make sure your API key is valid.
- Look for typos. Remember that JavaScript is a case-sensitive language.
- Use a JavaScript debugger. In Firefox, you can use the JavaScript console or the Firebug. In IE, you can use the Microsoft Script Debugger.
- If you need to examine the JSON string returned from the server, you can use JSON Lint to make a single, long string human readable.
- Email either iam-data-admin@ucdavis.edu or middleware-api@ucdavis.edu. with a description of your problem and a trace of the request and response.