OverviewApplication RequirementsEach request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>.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/orginfo/pps/depts/search?deptCode=061419&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":
[{
orgOId: "modifyDateF80B657CA1F923A0E0340003BA8A560D",
deptCode:"2012-01-18 13:14:01 "929879",
deptOfficialName: "MARKET RESEARCH",
deptDisplayName: "bouOrgOId"UCDHS:MARKET RESEARCH"F80B657C9EFA23A0E0340003BA8A560D",
"deptCode"deptAbbrev: "061419UCDMC","
isUCDHS":"N" true,
"orgOId"bouOrgOId: "F80B657C9F3A23A0E0340003BA8A560DF80B657C9EF423A0E0340003BA8A560D",
"createDate": "2010-07-13 12:59:02",
"deptOfficialName"modifyDate: "IET APPLICATION DEVELOPMENT",
"deptDisplayName":"IET APPLICATION DEVELOPMENT",
"deptAbbreviation":"IET APP DEVELOP"
2013-01-28 15:37:27"
}]},
"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
https://iet-ws.ucdavis.edu/api/iam/orginfo/pps/depts/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. Required URL ArgumentsThe following table lists the required 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 |
|---|
IETP:| 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 |
|---|
| IETP: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 |
|---|
orgOId | Unique IAM guid for this PPS department | deptCode | PPS unique deptcode | deptOfficialName | The official name for this department | deptDisplayName | The display name for this department | deptAbbrev | The abbreviation for this department | isUCDHS | Ytrue/Nfalse, 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. | 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 '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 |
|---|
|
|