Versions Compared

Old Version 21

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version Current

changes.mady.by.user Mary Northup

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...



Section


solid
Column
width20%


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




h4. h2. Overview h2. API Requirements {include:API Requirements} h2. 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:title=Sample JSON Request}

Overview

API Requirements

Column
Wiki Markup
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/ids/search?externalId=1234567890&key=myKey&v=1.0
{code}

The

response

to

all

of

the

above

requests

have a {color:#339966}Content-Type of text/javascript{color}.  An example response for the above request is shown below: {code:lang=xml|title=Sample JSON Response}

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": "1234567890",
 "mothraId": "12345678",
 "ppsId" : "123456789",
"employeeId": "123456789",
"studentId": "123456789",
"bannerPIdM": "1234567",
"externalId": null,
"employeeId": "12345678901"
"ucnetId":"1234567"
},
{
...<More results>.... }
 ],
  "responseDetails" : null,
  "responseStatus" : 0
}
{code}




h2. JSON Reference

{include:JSON Reference}

h3. {color:#808000}Request Format{color}


h4. URL Base Addresses

The following URL patterns are supported by the IAM Identity Store Core People API:

{code:lang=xml|title=Supported URL Patterns}

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:

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

https://iet-ws.ucdavis.edu/api/iam/people/ids/search

{code}

h4. {color:#002666}URL Arguments{color}

{include:URL Arguments}

h5. {color:#993366}Required URL Arguments (For both /api/iam/people/ids/{color}{iamid} {color:#993366}and /api/iam/people/ids/search){color}

{include:Required URL Arguments}

h5. {color:#993366}Supported URL arguments (For /api/iam/people/ids/search only){color}

{include:Supported URL Arguments}


|| URL || Supported Arguments ||
| [

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

URL

Supported Arguments

https://iet-ws.ucdavis.edu/api/iam/people/ids/search

|https://iet-ws.ucdavis.edu/api/iam/people/search] | mothraId \\ studentId \\ externalId \\ iamId \\ ppsId | h3. {color:#808000}Response Format{color} {include:Response Format for IET-WS APIs} h4. 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. | | mothraId \\ | Legacy unique ID from mothra system. \\ | | ppsId \\ | PPS employee ID \\ | | studentId | Banner student ID | | bannerPIdM | Banner alternative ID for faculty/instructors and students | | externalId | Unique ID from external systems | | results\[\] | results\[\]&nbsp;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&nbsp;.length&nbsp;property of this array will be set to 0. Therefore, results will never be null, and you can always safely check for&nbsp;results.length == 0. | h4. 'responseStatus' Codes and 'responseDetails' Messages {include:'responseStatus' Codes and 'responseDetails' Messages} h3. {color:#808000}Troubleshooting{color} {include:Troubleshooting IET-WS APIs}

mothraId
studentId
externalId
iamId
ppsId
employeeId

Response Format

Include Page
Response Format for IET-WS APIs
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

iamId

Unique University ID created by IAM system. Replaces MOTHRAID.

mothraId

Legacy unique ID from mothra system.

ppsId

PPS employee ID

studentId

Banner student ID

bannerPIdM

Banner alternative ID for faculty/instructors and students

externalId

Unique ID from external systems

employeeIdUnique  8-11 digit Employee Id – currently PPS employee ID will become UCPath employee ID.
ucnetIdUnique Id provided by UCOP for each employee, used for LMS access.

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



Column



Section