OverviewAPI Requirements Include Page |
---|
| API Requirements |
---|
| API Requirements |
---|
|
Getting StartedAs of version 1.0.8 of the IAM APIs (after UCPath), this API is deprecated. The 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/hs/titles/search?titleCode=9272&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":
[{
"modifyDate":"2012-01-18 13:14:02","titleCode":"9272",
"titleOId":"ACEB2A665667B745E040EDA9A9C2BA98",
"createDate":"2011-09-14 10:34:02",
"titleOfficialName":"Technician Dialysis I Pat Care",
"titleDisplayName":"Technician Dialysis I Pat Care"
}]
},
"responseDetails":"",
"responseStatus":0
}
|
JSON Reference 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/orginfo/hs/titles
https://iet-ws.ucdavis.edu/api/iam/orginfo/hs/titles/search
|
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 |
---|
titleOId | Unique IAM guid for this HS title | titleCode | UCDHS Peoplesoft unique title code | titleOfficialName | The official name for this title | titleDisplayName | The display name for this title | 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 Messages Include Page |
---|
| Response Codes and Messages |
---|
| Response Codes and Messages |
---|
|
Troubleshooting Include Page |
---|
| Troubleshooting IET-WS APIs |
---|
| Troubleshooting IET-WS APIs |
---|
|
|