Versions Compared

Old Version 16

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version Current

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
borderStylesolid
titleIn this Section
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/associations/sis/1000000389?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
langxml
titleSample JSON Response
{
"reponseData":{
"results":[
{

iamId: "12344567890",
levelCode: "UG",
levelName: "Undergraduate Level - Qtr.",
classCode: "SR",
className: "Senior",
collegeCode: "LS",
collegeName: "Letters & Science",
assocRank: "2",
assocStartDate: null,
assocEndDate: null,
majorCode: "LPOL",
majorName: "Political Science",
fepraCode: "D",
createDate: "2012-07-19 16:57:36",
modifyDate: null


}
]},
"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
langxml
titleSupported URL Patterns
https://iet-ws.ucdavis.edu/api/iam/associations/sis/{iamId}

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

iamId
levelCode
levelName
classCode
className
collegeCode
collegeName
assocRank
majorCode
majorName
ferpaCode
retType

Response Format

Include Page
Response Format for IET-WS APIs
Response Format for IET-WS APIs

Supported Return Type (retType) Values

Note: For /associations/sis/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.

levelCode

Banner student level code

levelName

Banner student level description

classCode

Banner student class code

className

Banner student class description

collegeCode

Banner college code

collegeName

Banner college name

assocRank

Ranks multiple associations by ZGVOCFS_LFOS_ORDER from Banner.

assocStartDate

Reported start date for the association

assocEndDate

Reported end date for the association

majorCode

Banner major code

majorName

Banner major description

ferpaCode

Banner conf code for FERPA

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.

'responseStatus' Codes and 'responseDetails' Messages

Include Page
Response Codes and Messages
Response Codes and Messages

Troubleshooting

Include Page
Troubleshooting IET-WS APIs
Troubleshooting IET-WS APIs

...