View Source

Overview

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.

	curl -i -H "Accept: application/json" https://iet-ws.ucdavis.edu/api/iam/associations/odr/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:

{
"reponseData":{
"results":[
{
iamId: "1000028499",
deptCode: "8015",
deptOfficialName: "IET Appl Dev/Data Admin",
deptDisplayName: "APPLICATION DEVELOPMENT & DATA ADMINISTRATION",
deptAbbrev: "IET Appl Dev/Data Admin",
isUCDHS: false,
assocRank: "1",
assocStartDate: null,
assocEndDate: null,
titleOfficialName: "Manager",
titleDisplayName: "Manager",
createDate: "2012-07-10 09:16:25",
modifyDate: "2012-07-20 14:05:27"

}
]},
"responseDetails":null,
"responseStatus":0
}

JSON Reference

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/associations/odr/{iamId}

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

URL Arguments

Required URL Arguments

Other Supported URL arguments

URL	Supported Arguments
https://iet-ws.ucdavis.edu/api/iam/associations/odr/search	iamId deptCode isUCDHS bouOrgId titleCode assocRank retType

Response Format

Supported Return Type (retType) Values

Note: For /associations/odr/search ONLY

retType	Description
default	Returns the data from the default underlying Identity Store view (see below 'Results Array: Guaranteed Fields' for this API)
people	Returns the data from the CV_PEOPLE view. (See 'Results Array: Guaranteed Fields' for the People API: https://confluence.ucdavis.edu/confluence/display/IETP/Identity+Store+Core+People+API)
iamids	Returns only IAMIds

Results Array: Guaranteed Fields

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.
deptCode	Online Directory department code (from Amcom)
deptOfficialName	Online Directory department name (from Amcom)
deptDisplayName	Online Directory department display name (from Amcom)
deptAbbrev	Online Directory department abbreviation (from Amcom)
isUCDHS	true/false, is the department an UCDHS department
assocRank	Ranks multiple associations from Online Directory.
assocStartDate	NULL
assocEndDate	NULL
titleOfficialName	Online Directory title name (from Amcom)
titleDisplayName	Online Directory title display name (from Amcom)
createDate	The date this association was created in the IAM system
modifyDate	The last date this association 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.