Versions Compared

Old Version 13

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version 14

changes.mady.by.user Gary Sharpe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 12

...

Section
Column
width20%

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




Required
URL
Arguments
(For BOTH /people/prikerbacct/{iamid} and /people/prikerbacct/search)
Column

Overview

API Requirements

Include Page
IETP:API Requirements
IETP: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/prikerbacct/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:

Code Block
langxml
titleSample JSON Response
{
  "responseData" : {
    "results" : [
{
"iamId": "",
"userId": "",
"uuId" : "",
"createDate": "",
"claimDate": "",
"expireDate": ""


},
{ ...<More results>.... }
 ],
  "responseDetails" : null,
  "responseStatus" : 0
}

JSON Reference

Include Page
IETP:JSON Reference
IETP: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/people/prikerbacct/{iamid}

URL Arguments

Include Page
IETP:URL Arguments
IETP:URL Arguments
Wiki Markup
Include Page
IETP:Required URL Arguments
IETP:Required URL Arguments
Other
Supported URL
arguments (For /people/prikerbacct/search ONLY)
arguments
Include Page
IETP:Supported URL Arguments
IETP:Supported URL Arguments

Response Format

Include Page
IETP:Response Format for IET-WS APIs
IETP:Response Format for IET-WS APIs
Supported Return Type (retType) Values (For /people/prikerbacct/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 |
h4. Results Array: Guaranteed Fields

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.

|

|

userId

|

Kerberos loginid

|

uuId

| uuId |

UNIX UID

|

createDate

| createDate |

Date this account was created

|

|

claimDate

|

Date this account was claimed by the end user

|

|

expireDate

|

Date the account expired or was disabled

|

|

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.

|

h4.

'responseStatus' Codes and 'responseDetails' Messages

Include Page
IETP:'responseStatus' Codes and 'responseDetails' Messages
IETP:'responseStatus' Codes and 'responseDetails' Messages
h3.

Troubleshooting

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

...