Page Comparison

...

Request Format

URL Base Addresses

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

Section

Column

width	20%

Panel

borderColor	#BF9900
bgColor	#FFFFFF
titleBGColor	#E5D699
title	In this Section
borderStyle	solid

Table of Contents

indent	15px
style	none

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.

Column

Overview

API Requirements

Include Page

IETP:API Requirements

Code Block

title	Sample JSON Request

Wiki Markup



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&nbsp;curl&nbsp;command line tool to execute sample queries.

{code:title=Sample 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 Content-Type of text/javascript. An example response for the above request is shown below:

Code Block

lang	xml
title	Sample JSON Response

 have a&nbsp;{color:#339966}Content-Type&nbsp;of&nbsp;text/javascript{color}. &nbsp;An example response for the&nbsp;above request is shown below:
{code:lang=xml|title=Sample JSON Response}
{
  "responseData" : {
    "results" : [
{
 "iamId": "",
 "mothraId": "",
 "ppsId" : "",
"studentId": "",
"bannerPIdM": "",
"externalId": ""


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




h2. JSON Reference



{include

IETP

:JSON

Reference

IETP:JSON Reference

Code Block

lang	xml
title	Supported URL Patterns

 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}
https://iet-ws.ucdavis.edu/api/iam/people/ids/{iamid}

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

{code}

URL Arguments

Include PageIETP:URL ArgumentsIETP:URL Arguments Wiki Markup


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)

Include PageIETP

{color}

{include:Required URL

ArgumentsIETP:Required URL ArgumentsSupported URL arguments (For

 Arguments}

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

Include PageIETP

{color}

{include:Supported URL

ArgumentsIETP:Supported URL Arguments

URL

Supported Arguments

 Arguments}


|| URL || Supported Arguments ||
| [https://iet-ws.ucdavis.edu/api/iam/people/ids/search

mothraId
studentId
externalId
iamId
ppsId

Response Format

Include PageIETP: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
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[] 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' Codes and 'responseDetails' Messages

Include PageIETP:'responseStatus' Codes and 'responseDetails' MessagesIETP:'responseStatus' Codes and 'responseDetails' Messages

Troubleshooting

Include PageIETP:Troubleshooting IET-WS APIsIETP:Troubleshooting IET-WS APIs

|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}

Column

Section

Versions Compared

Old Version 20

New Version 21

Key

Request Format

URL Base Addresses

Getting Started

Overview

API Requirements

URL Arguments

Response Format

Results Array: guaranteed fields

'responseStatus' Codes and 'responseDetails' Messages

Troubleshooting