Column |
---|
|
Panel |
---|
borderColor | #BF9900 |
---|
bgColor | #FFFFFF |
---|
titleBGColor | #E5D699 |
---|
borderStyle | solid |
---|
title | In this Section |
---|
|
| borderStyle | solid |
---|
Column |
---|
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/associations/pps/1000014336&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",
"deptCode":"061419",
"deptOfficialName":"IET APPLICATION DEVELOPMENT",
"modifyDatedeptDisplayName":null"IET APPLICATION DEVELOPMENT",
"assocRankdeptAbbreviation":"1""IET APP DEVELOP",
"isUCDHS":false,
"bouOrgOId":"F80B657C9EFA23A0E0340003BA8A560D",
"deptCodeadminDeptCode":"061419",
"isUCDHSadminDeptOfficialName":"NIET APPLICATION DEVELOPMENT",
"titleCodeadminDeptDisplayName":"7287IET APPLICATION DEVELOPMENT",
"createDateadminDeptAbbrev":"2011-09-19 09:20:32IET APP DEVELOP",
"adminIsUCDHS":false,
"adminBouOrgOId":"061419",
"apptDeptCode":"061419",
"deptOfficialNameapptDeptOfficialName":"IET APPLICATION DEVELOPMENT",
"deptDisplayNameapptDeptDisplayName":"IET APPLICATION DEVELOPMENT",
"deptAbbreviationapptDeptAbbrev":"IET APP DEVELOP",
"apptIsUCDHS":false,
"apptBouOrgOId":"061419",
"assocRank":"1",
"assocStartDate":"2011-02-16 00:00:00",
"assocEndDate":"9999-12-31 00:00:00",
"titleCode":"7287",
"titleOfficialName":"PROGRAMMER V",
"titleDisplayName":"PROGRAMMER V",
"positionTypeCode":"2",
"positionType":"Regular/Career",
"percentFullTime":"1",
"createDate":"2012-11-19 14:56:26",
"modifyDate":"2016-11-17 16:00:39",
"emplClass":"2",
"emplClassDesc":"Staff: Career"
}]},
"responseDetails":"Successfully Processed Request.","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/associations/pps/{iamid}
https://iet-ws.ucdavis.edu/api/iam/associations/pps/search
|
URL Arguments Include Page |
---|
| IETP:URL ArgumentsIETP: |
---|
| URL Arguments |
---|
|
Required URL Arguments Include Page |
---|
| IETP:Required URL ArgumentsIETP: |
---|
| Required URL Arguments |
---|
|
Other Supported URL argumentsIETP:IETP: bouOrgId adminDeptCode adminIsUCDHS apptDeptCode apptIsUCDHS bouOrgOId titleCode assocRank retType
|
Include Page |
---|
| IETP:Response Format for IET-WS APIsIETP: |
---|
| Response Format for IET-WS APIs |
---|
|
Supported Return Type (retType) ValuesNote: For /associations/pps/search ONLY retType | Description |
---|
default | Returns the data from the default underlying Identity Store view (see below 'Results Array: Guaranteed Fields' for this API) | people | Returns the data from the CV_PEOPLE view. (See 'Results Array |
: guaranteed fieldsResults Array: Guaranteed 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. | deptCode | PPS | Home deptcode 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 | YNfalse, 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 | 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 | . 'responseStatus' Codes and 'responseDetails' Messages Include Page |
---|
| IETP:'responseStatus' Codes and 'responseDetails' Messages | IETP:'responseStatus' Codes and 'responseDetails' . | emplClass | The employee class code. (Valid values are 1,2,3,4,5,6,7,8,9,10,11,13,14,15,20,21,22,23,24 and C) | emplClassDesc | The employee class description. |
Response Codes and Messages Include Page |
---|
| Response Codes and Messages |
---|
| Response Codes and Messages |
---|
|
Troubleshooting Include Page |
---|
| IETP:Troubleshooting IET-WS APIsIETP: |
---|
| Troubleshooting IET-WS APIs |
---|
|
|