OverviewAPI Requirements Include Page |
---|
| IETP:API RequirementsIETP: |
---|
| API Requirements |
---|
|
Getting StartedThe 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 |
---|
| curl -i -H "Accept: application/json" https://iet-ws-test.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 |
---|
lang | xml |
---|
title | Sample 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":nulltrue,
"isHSEmployee":nullfalse,
"isFaculty":"N"false,
"isStudent":"N"false,
"isStaff":"Y"true,
"isExternal":"N"false,
"privacyCode":null
}
]},
"responseDetails":null,
"responseStatus":0
}
|
JSON Reference Include Page |
---|
| IETP:JSON ReferenceIETP: |
---|
| JSON Reference |
---|
|
URL Base AddressesThe following URL patterns are supported by the IAM Identity Store Core People API: Code Block |
---|
lang | xml |
---|
title | Supported URL Patterns |
---|
|
https://iet-ws.ucdavis.edu/api/iam/people/{iamid}
https://iet-ws.ucdavis.edu/api/iam/people/search
|
URL Arguments Include Page |
---|
| IETP:URL ArgumentsIETP: |
---|
| URL Arguments |
---|
|
Required URL ArgumentsArguments Include Page |
---|
| IETP:Required URL ArgumentsIETP: |
---|
| Required URL Arguments |
---|
|
Other Supported URL argumentsIETP:IETP:, , , oFullName, , , , dFullName, , , , , , Include Page |
---|
| IETP:Response Format for IET-WS APIsIETP: |
---|
| Response Format for IET-WS APIs |
---|
|
Results Array: guaranteed fieldsGuaranteed FieldsThe 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 Name (Will be replaced with lived name in the next version release) | oLastName | Official Last | Name Name (Will be replaced with lived name in the next version release) | oSuffix | Official | Suffix Suffix (Will be replaced with lived name in the next version release) | oFullName | Composite of O_[F/M/L] | NAME NAME (Will be replaced with lived name in the next version release) | dFirstName | Display Lived First Name (from Online Directory) | dMiddleName | Display Lived Middle Name (from Online Directory) | dLastName | Display Lived Last Name (from Online Directory) | dSuffix | Display Lived Suffix (from Online Directory) | dPronouns | Lived Preferred Pronouns (from Online Directory) | dFullName | Composite of | DLived_[F/M/L]NAME | isEmployee | YNfalse, Does the person have an employee affiliation (either staff or faculty) | isHSEmployee | YNfalse, Does the person have an employee affiliation from the UCDHS | isFaculty | YNfalse, Does the person have a faculty affiliation | isStudent | YNfalse, Does the person have a student affiliation | isStaff | YNfalse, Does the person have a staff affiliation | isExternal | YNfalse, 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. |
'responseStatus' Response Codes and 'responseDetails' Messages Include Page |
---|
| IETP:'responseStatus' Response Codes and 'responseDetails' MessagesIETP:'responseStatus' |
---|
| Response Codes and 'responseDetails' Messages |
---|
|
Troubleshooting Include Page |
---|
| IETP:Troubleshooting IET-WS APIsIETP: |
---|
| Troubleshooting IET-WS APIs |
---|
|
|