OverviewAudienceApplication RequirementsEach request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>.API Requirements| Include Page |
|---|
| API Requirements |
|---|
| 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 the following above request is shown below: | Code Block |
|---|
| lang | xml |
|---|
| title | Sample JSON Response |
|---|
| {
"reponseData":
{
"reponseDataresults":[
{
"recordsReturnediamId":1"1000014336",
"resultsdeptCode":["061419",
{"iamiddeptOfficialName":"1000014336IET APPLICATION DEVELOPMENT",
"modifyDatedeptDisplayName":null,"assocRank":"1","bouorgOId"IET APPLICATION DEVELOPMENT",
"deptAbbreviation":"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 ReferenceUnlike 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.| Include Page |
|---|
| JSON Reference |
|---|
| 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 ArgumentsThis 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.| Include Page |
|---|
| URL Arguments |
|---|
| URL Arguments |
|---|
|
Required URL Arguments| Include Page |
|---|
| Required URL Arguments |
|---|
| Required URL Arguments |
|---|
|
The following table lists the required Other Supported URL arguments. Argument | Example | Description |
|---|
key | key=your-key | This argument supplies the application's key. You can sign up for an API key <INSERT LINK HERE>.
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. |
Supported URL argumentsThe 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.| Include Page |
|---|
| Supported URL Arguments |
|---|
| Supported URL Arguments |
|---|
|
| 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 Results Array: guaranteed fieldsGuaranteed FieldsThe results array always contains the parameters listed in this section, even if the value is empty. | |
|---|
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 | 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. |
| 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 |
|---|
|
|