OverviewApplication 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.ucdavis.edu/api/iam/orginfo/pps/depts/reportsTo?deptCode=062006&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":"1000084348",
"deptCode":"061419",
"deptOfficialName":"IET-ENT INFRA SVCS",
"deptDisplayName":"IET-ENT INFRA SVCS",
"deptAbbrev":"IET-EIS",
"isUCDHS":false,
"bouOrgOId":"F80B657C9EFA23A0E0340003BA8A560D",
..........
"assocRank":"1",
"assocStartDate":"2019-01-13 00:00:00",
"assocEndDate":null,
"titleCode":"008291",
"titleOfficialName":"TELEVISION TCHN PRN",
"titleDisplayName":"TELEVISION TCHN PRN",
"positionTypeCode":"2",
"positionType":"Regular/Career",
"percentFullTime":"1",
"createDate":"2019-01-10 11:33:41",
"modifyDate":"2021-01-20 14:00:52",
"emplClass":"2",
"emplClassDesc":"Staff: Career",
"emplPositionNumber":"40237482",
"reportsToEmplID":"10206139",
"reportsToPositionNum":"40224687"
}]},
"responseDetails":"",
"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.
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/orginfo/pps/depts/reportsTo?deptCode=062006
|
URL Arguments| Include Page |
|---|
| URL Arguments |
|---|
| URL Arguments |
|---|
|
Required URL Arguments| Include Page |
|---|
| Required URL Arguments |
|---|
| Required URL Arguments |
|---|
|
Supported URL arguments| Include Page |
|---|
| Supported URL Arguments |
|---|
| Supported URL Arguments |
|---|
|
| Include Page |
|---|
| Response Format for IET-WS APIs |
|---|
| Response Format for IET-WS APIs |
|---|
|
Results Array: Guaranteed FieldsThe results array always contains the parameters listed in this section, even if the value is empty. Property | Description |
|---|
orgOId | Unique IAM guid for this PPS department | deptCode adminDeptCode apptDeptCode | PPS unique deptcode | deptOfficialName adminDeptOfficialName apptDeptOfficialName | The official name for this department | deptDisplayName adminDeptDisplayName apptDeptDisplayName | The display name for this department | deptAbbrev adminDeptAbbrev apptDeptAbbrev | The abbreviation for this department | isUCDHS | true/false, is the department an UCDHS department | bouOrgOId | Unique IAM guid for the parent BOU department | createDate | The date this record was created in the IAM system. | modifyDate | The last date this record was modified in the IAM system. | | assocRank | For individuals with multiple associations, this ranks them by title code. | | assocStartDate | Reported start date for the association | | assocEndDate | Reported end date for the association | | titleCode | PPS title code | | 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. | | 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. | | emplPositionNumber | The employee position number. | | reportsToEmplID | The employee ID of the manager/supervisor the given employee reports to. | | reportsToPositionNum | The position number of the manager/supervisor the given employee reports to. | 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 |
|---|
|
|