Versions Compared

Old Version 23

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version 24

changes.mady.by.user Gary Sharpe

Saved on

Key

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

Section
Column
width20%

Panel
borderStyle
borderColor#BF9900
bgColor#FFFFFF
titleBGColor#E5D699
borderStylesolid
titleIn this Sectionsolid
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-test.ucdavis.edu/api/iam/people/contactinfo/1000000009?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:

xml
Code Block
lang
titleSample JSON Response
langxml
{
  "responseData" : {
    "results" : [
{


iamId: "1001234567",
email: "john.doe@ucdmc.ucdavis.edu",
hsEmail: null,campusEmail: null,addrStreet: "4133 V St",
addrCity: "Sacramento",
addrState: "CA",
addrZip: "95817",
postalAddress: "4133 V St$Sacramento, CA 95817",
workPhone: null,
workCell: null,
workPager: null,
workFax: 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:

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

https://iet-ws.ucdavis.edu/api/iam/people/contactinfo/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

Response Format

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

Supported Return Type (retType) Values

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

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.

email

Preferred email address. (1) Online Dir, (2) HS_EMAIL, (3) CAMPUS_EMAIL

hsEmail

UCDHS email address

campusEmail

Campus email address

addrStreet

Primary work address.

addrCity

Primary work address.

addrState

Primary work address.

addrZip

Primary work address.

postalAddress

Primary work address.

workPhone

Work phone number

workCell

Work mobile phone number

workPager

Work pager and carrier

workFax

Work fax number

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

...