Identity Store Affiliations API

DRAFT * DRAFT * DRAFT

In this Section

Overview

API Requirements

Each request must provide a valid API Key. You may request your own API Key by emailing either iam-data-admin@ucdavis.edu or middleware-api@ucdavis.edu.

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.

Sample JSON Request

	curl -i -H "Accept: application/json" https://iet-ws-test.ucdavis.edu/api/iam/people/affiliations/1000000009?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:

Sample JSON Response

{
  "responseData" : {
    "results" : [
{
 "iamId": "",
"isEmployee": "",
"isHSEmployee": "",
"isFaculty": "",
"isStudent": "",
"isStaff": ""
"isExternal": ""



},
{ ...<More results>.... }
 ],
  "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">Request Format

URL Base Addresses

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

Supported URL Patterns

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

URL Arguments">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">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 may request your own API Key by emailing either [mailto:iam-data-admin@ucdavis.edu] or [mailto:middleware-api@ucdavis.edu].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">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.

URL	Supported Arguments
[https://iet-ws.ucdavis.edu/api/iam/people/affiliations/ Unknown macro: {iamId\|https}