Page Comparison

Overview

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.

	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:

{
  "responseData" : {
    "results" : [
{
 "iamId": "",
 "mothraId": "",
 "ppsId" : "",
"studentId": "",
"bannerPIdM": "",
"externalId": ""


},
{ ...<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

Request Format

URL Base Addresses

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

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}

URL Arguments

Wiki Markup
Required URL Arguments (For both /api/iam/people/ids/

{iamid}

and /api/iam/people/ids/search)

Supported URL arguments (For /api/iam/people/ids/search

only)

Include Page
IETP:Supported URL Arguments IETP: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\[\] 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:'responseStatus' Codes and 'responseDetails' Messages} h3. {color:#808000}Troubleshooting{color} {include:Troubleshooting IET-WS APIs}

mothraId studentId externalId iamId ppsId

Response Format

Results Array: Guaranteed Fields

The results array always contains the parameters listed in this section, even if the value is empty.

'responseStatus' Codes and 'responseDetails' Messages

Troubleshooting