Page Comparison

Overview

Audience

Application Requirements

Each request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>.

Getting Started

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.

	curl -i -H "Accept: application/json" https://iet-ws-test.ucdavis.edu/api/iam/orginfo/ppsdepts/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 the following request is shown below:

 {
"reponseData":{
"recordsReturned":1,"results":[
{
"iamidmodifyDate":"1000014336",
"mothraId":null,
"ppsid":null,
"studentId":null,
"externalId":null,
"dFirstName":null,
"dFullName":" ",
"dLastName":null,
"dMiddleName":null,
"modifyDate":null,
"oFirstName":"GARY",
"oFullName":"GARY SHARPE",
"oLastName":"SHARPE",
"oMiddleName":null,
"bannerPIdM":null,
"oSuffix":null,
"dSuffix":null,
"isEmployee":null,
"isHSEmployee":null,
"isFaculty":"N",
"isStudent":"N",
"isStaff":"Y",
"isExternal":"N",
"privacyCode":null
}
]},
"responseDetails":null,
"responseStatus":0
2012-01-18 13:14:01","bouorgOId":"F80B657C9EFA23A0E0340003BA8A560D","deptCode":"061419","isUCDHS":"N","orgOId":"F80B657C9F3A23A0E0340003BA8A560D","createDate":"2010-07-13 12:59:02","deptOfficialName":"IET APPLICATION DEVELOPMENT","deptDisplayName":"IET APPLICATION DEVELOPMENT","deptAbbreviation":"IET APP DEVELOP"}]},"responseDetails":"Successfully Processed Request.","responseStatus":0}

JSON Reference

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.

Request Format

URL Base Addresses

The following URL patterns are supported by the IAM Identity Store Core People API:

https://iet-ws.ucdavis.edu/api/iam/people/{iamid}

https://iet-ws.ucdavis.edu/api/iam/people/search

URL Arguments

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.

Required URL Arguments

The following table lists the required URL arguments.

Supported URL arguments

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.

Response Format

Each response follow this general format:

{
  "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

The results array always contains the parameters listed in this section, even if the value is empty.

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.

Troubleshooting

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.