Versions Compared

Old Version 9

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version 10

changes.mady.by.user Gary Sharpe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width20%

Panel
borderColor#BF9900
bgColor#FFFFFF
titleBGColor#E5D699
titleIn this Section
borderStylesolid
Table of Contents
indent15px
stylenone




Column

Overview

Application Requirements

Each request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>.
Include Page
IETP:API Requirements
IETP: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
titleSample JSON Request
	curl -i -H "Accept: application/json" https://iet-ws-test.ucdavis.edu/api/iam/ids/search?externalId=1234567890&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:

Code Block
langxml
titleSample JSON Response
{
  "responseData" : {
    "results" : [
{
 "iamId": "",
 "mothraId": "",
 "ppsId" : "",
"studentId": "",
"bannerPIdM": "",
"externalId": ""


},
{ ...<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

URL Base Addresses

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

Code Block
langxml
titleSupported URL Patterns
https://iet-ws.ucdavis.edu/api/iam/ids/{iamid}

https://iet-ws.ucdavis.edu/api/iam/ids/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

Include Page
IETP:Response Format for IET-WS APIs
IETP: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

iamId

Unique University ID created by IAM system. Replaces MOTHRAID.

mothraId

Legacy unique ID from mothra system.

ppsId

PPS employee ID

studentId

Banner student ID

bannerPIdM

Banner alternative ID for faculty/instructors and students

externalId

Unique ID from external systems

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

Include Page
IETP:Troubleshooting IET-WS APIs
IETP:Troubleshooting IET-WS APIs

...