Versions Compared

Old Version 16

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version Current

changes.mady.by.user anithakumar

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
borderStylesolid
Table of Contents
indent15px
stylenone




Column

Overview

API Requirements

Include Page
IETP:API RequirementsIETP:
API Requirements

Getting Started

As of version 1.0.8 of the IAM APIs (after UCPath), this API is deprecated.

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/associations/hs/1000023875?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":"1000023875",
"modifyDate":"2011-10-26 12:44:30",
"assocRank":"1","titleCode":"9139C",
"costCenterCode":"H 1009645",
"createDate":"2011-10-25 15:58:26",
"assocStartDate":"1993-07-26 00:00:00",
"assocEndDate":null,
"titleOfficialName":"Nurse Clinical II",
"titleDisplayName":"Nurse Clinical II",
"costCenterOfficialName":"D-10 Pediatric ICU/PCICU",
"costCenterDisplayName":"D-10 Pediatric ICU/PCICU",
"costCenterAbbreviation":"D10 PICU"
}]},
"responseDetails":"Successfully Processed Request.",
"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/associations/hs/{iamid}

https://iet-ws.ucdavis.edu/api/iam/associations/hs/search

URL Arguments

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

Include Page

IETP:

Supported URL Arguments

IETP:

Supported URL Arguments

URL

Supported Arguments

https://iet-ws.ucdavis.edu/api/iam/associations/hs/search

iamId
costCenterCode
titleCode
assocRank

Response Format

Include Page
IETP:Response Format for IET-WS APIsIETP:
Response Format for IET-WS APIs

Supported Return Type (retType) Values

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

Results Array: guaranteed fields

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.

costCenterCode

HS cost center code

costCenterOfficialName

HS cost center name

costCenterDisplayName

HS cost center display name

costCenterAbbrev

HS cost center abbreviation

assocRank

For individuals with multiple associations, this ranks them by titlecode.

assocStartDate

Reported start date for the association

assocEndDate

Reported end date for the association

titleCode

HS titlecode

titleOfficialName

HS title name

titleDisplayName

HS title display name

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'

Response Codes and

'responseDetails'

Messages

Include Page
IETP:'responseStatus' Response Codes and 'responseDetails' MessagesIETP:'responseStatus'
Response Codes and 'responseDetails' Messages

Troubleshooting

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


...