Identity Store SIS Majors API

DRAFT * DRAFT * DRAFT

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.

Sample JSON Request

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


{
"reponseData":{
"results":[
{
"modifyDate":null,
"majorCode":"GDWR",
"titleOId":"AF99164BF58BAC12E040EDA9A9C2282A",
"majorName":"Writing, Rhet & Comp Studies",
"createDate":"2011-10-18 12:54:11"},
 
...

]},
"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:

Supported URL Patterns


https://iet-ws.ucdavis.edu/api/iam/orginfo/sis/majors

https://iet-ws.ucdavis.edu/api/iam/orginfo/sis/majors/search

URL Arguments

Required URL Arguments

Supported URL arguments

URL	Supported Arguments

URL	Supported Arguments
https://iet-ws.ucdavis.edu/api/iam/orginfo/sis/majors/search	titleOId majorCode

Response Format

Results Array: guaranteed fields

The results array always contains the parameters listed in this section, even if the value is empty.

Property	Description

Property	Description
titleOId	Unique IAM guid for this Banner major
majorCode	Banner major code
majorName	Banner major description
createDate	The date this record was created in the IAM system.
modifyDate	The last date this record 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.