Versions Compared

Old Version 28

changes.mady.by.user Gouthami Narala

Saved on

compared with

New Version 29

changes.mady.by.user Mary Northup

Saved on

Key

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

  


Section


Column
width20%


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




Column

Overview

API Requirements

Include Page
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
titleSample JSON Request
	curl -i -H "Accept: application/json" https://iet-ws.ucdavis.edu/api/iam/people/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 above request is shown below:

Code Block
lang
langxml
titleSample JSON Responsexml
{
  "responseData" : {
    "results" : [
{
 "iamId": "1234567890",
 "mothraId": "12345678",
 "ppsId" : "123456789",
"studentId": "123456789",
"bannerPIdM": "1234567",
"externalId": null,
"employeeId": "12345678901"

},

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

JSON Reference

Include Page
JSON Reference
JSON Reference

Request Format

URL Base Addresses

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

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

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

URL Arguments

Include Page
URL Arguments
URL Arguments
Required URL Arguments
Include Page
Required URL Arguments
Required URL Arguments
Other Supported URL arguments 

Include Page
Supported URL Arguments
Supported URL Arguments

URL

Supported Arguments

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

mothraId
studentId
externalId
iamId
ppsId

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

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.

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