Versions Compared

Old Version 21

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version 22

changes.mady.by.user Gary Sharpe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Warning
titleDRAFT * DRAFT * DRAFT

Section
Column
width20%

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




Column

Overview

API Requirements

Include Page
IETP:API RequirementsIETP:
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/orginfo/pps/divisions/search?orgOId=F80B657C9EFA23A0E0340003BA8A560D&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":
[{
orgOId: "F80B657C9EE123A0E0340003BA8A560D",
deptCode: "73",
deptOfficialName: "VICE CHANCELLOR - UNIVERSITY RELATIONS",
deptDisplayName: "UNIVERSITY RELATIONS",
deptAbbrev: "UNIV REL",
isUCDHS: false,
createDate: "2010-07-13 12:59:02",
modifyDate: "2013-01-28 15:37:27"

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

JSON Reference

Include Page
IETP:JSON ReferenceIETP:
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/orginfo/pps/divisions
https://iet-ws.ucdavis.edu/api/iam/orginfo/pps/divisions/search

URL Arguments

Include Page
IETP:URL ArgumentsIETP:
URL Arguments
Required URL Arguments
Include Page
IETP:Required URL ArgumentsIETP:
Required URL Arguments
Supported URL arguments
Include Page
IETP:Supported URL ArgumentsIETP:
Supported URL Arguments

URL

Supported Arguments

https://iet-ws.ucdavis.edu/api/iam/orginfo/pps/divisions/search

orgOId
deptCode

Response Format

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

orgOId

Unique IAM guid for this PPS BOU

deptCode

PPS unique deptcode

deptOfficialName

The official name for this department

deptDisplayName

The display name for this department

deptAbbreviation

The abbreviation for this department

isUCDHS

true/false, is the department an UCDHS department

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.

Response Codes and Messages

Include Page
IETP:Response Codes and MessagesIETP:
Response Codes and Messages

Troubleshooting

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

...