Page Comparison

...

title	DRAFT * DRAFT * DRAFT

Section

Column

width	20%

Panel

borderColor	#BF9900
bgColor	#FFFFFF
titleBGColor	#E5D699
borderStyle	solid
title	In this Section

borderStyle

solid

Table of Contents

indent	15px
style	none

Column

Overview

Application Requirements

Audience

Include Page

Application Requirements

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

	API Requirements
	API Requirements

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.

Code Block

title	Sample JSON Request

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

Code Block

lang	xml
title	Sample JSON Response


{
"reponseData":
{
"results":
[
{
"iamid"orgOId: "1000014336F80B657CA1F923A0E0340003BA8A560D",
"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
}
deptCode: "929879",
deptOfficialName: "MARKET RESEARCH",
deptDisplayName: "UCDHS:MARKET RESEARCH",
deptAbbrev: "UCDMC",
isUCDHS: true,
bouOrgOId: "F80B657C9EF423A0E0340003BA8A560D",
createDate: "2010-07-13 12:59:02",
modifyDate: "2013-01-28 15:37:27"
}]},
"responseDetails":null"",
"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:

Code Block

lang	xml
title	Supported URL Patterns


https://iet-ws.ucdavis.edu/api/iam/orginfo/people/{iamid}
pps/depts
https://iet-ws.ucdavis.edu/api/iam/peopleorginfo/pps/depts/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.

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 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:

Code Block

lang	xml


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

	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

URL	Supported Arguments
https://iet-ws.ucdavis.edu/api/iam/orginfo/pps/depts/search	orgOId deptCode

Response Format

Include Page

	Response Format for IET-WS APIs
	Response Format for IET-WS APIs

Results Array: Guaranteed Fields

The 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	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.
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.

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.

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

Column

Section

Versions Compared

Old Version 4

New Version Current

Key

Overview

Application Requirements

Application Requirements

Getting Started

JSON Reference

Request Format

URL Base Addresses

URL Arguments

Required URL Arguments

Supported URL arguments

Response Format

Required URL Arguments

Supported URL arguments

Response Format

Results Array: Guaranteed Fields

Troubleshooting

Response Codes and Messages

Troubleshooting