| Audience Each request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>. | API Requirements | | API Requirements |
|---|
|
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-test.ucdavis.edu/api/iam/people/contactinfo/1000000009?key=myKeyvmyKey&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 the above request is shown below: | Code Block |
|---|
| lang | xml |
|---|
| title | Sample JSON Response |
|---|
|
| {
"responseData" : {
"results" : [
{
"IAMId"iamId: "1001234567",
"email": " "john.doe@ucdmc.ucdavis.edu",
"hsEmail" : "" null,
"campusEmail": "" null,
"addrStreet: ":4133 V St"",
"addrCity": "Sacramento",
"addrState" : "CA",
"addrZip": "95817",
"postalAddress": "",
"workPhone" : "",
"workCell": "",
"workPager" : "",
"workFax": "": "4133 V St$Sacramento, CA 95817",
workPhone: null,
workCell: null,
workPager: null,
workFax: null
},
{ ...<More
results>....
}
],
"responseDetails" : null,
"responseStatus" : 0
}
|
Unlike 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 |
|---|
|
The 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/people/contactinfo/{iamid}
https://iet-ws.ucdavis.edu/api/iam/people/contactinfo/search
|
This 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 |
|---|
|
| Include Page |
|---|
| Required URL Arguments |
|---|
| Required URL Arguments |
|---|
|
The following table lists the required . 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. |
The 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. Each response follow this general format: | Code Block |
|---|
|
{
"responseData" : {
"results" : []
},
"responseDetails" : null | string-on-error,
"responseStatus" : 0 | error-code
}
|
In the JSON fragment above, note that the responseData property contains a results array and an optional cursor. Results Array: guaranteed fields| Include Page |
|---|
| Supported URL Arguments |
|---|
| Supported URL Arguments |
|---|
|
URL | Supported Arguments |
|---|
https:// iet-ws.ucdavis.edu/api/iam/people/contactinfo /search | iamId
email hsEmail campusEmail retType |
| Include Page |
|---|
| Response Format for IET-WS APIs |
|---|
| Response Format for IET-WS APIs |
|---|
|
The 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. | email | Preferred email address. (1) Online Dir, (2) HS_EMAIL, (3) CAMPUS_EMAIL | hsEmail | UCDHS email address | campusEmail | Campus email address | addrStreet | Primary work address. | addrCity | Primary work address. | addrState | Primary work address. | addrZip | Primary work address. | postalAddress | Primary work address. | workPhone | Work phone number | workCell | Work mobile phone number | workPager | Work pager and carrier | workFax | Work fax number | 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. |
The responseStatus property contains a value of 0 on success and a custom error status code on failure. If there is a failure, responseDetails contains a diagnostic string. If you encounter problems with your code: - Make sure your API key is valid.
- Look for typos. Remember that JavaScript is a case-sensitive language.
- Use a JavaScript debugger. In Firefox, you can use the JavaScript console or the Firebug. In IE, you can use the Microsoft Script Debugger.
- If you need to examine the JSON string returned from the server, you can use JSON Lint to make a single, long string human readable.
- Email middleware-api@ucdavis.edu with a description of your problem and a trace of the request and response.
|