Page Comparison

Overview

These APIs provide a bulk load API for data that is published from the Online Directory system.

We may be deprecating this function soon (September 1, 2022).
If you need assistance with this APIs, please email middleware-api@ucdavis.edu.

Audience

This is currently the only interface available for

this API. If you would like to see an XML interface please email middleware-api@ucdavis.edu.

Application requirements

Each request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>.

During periods of peak usage, API requests may be throttled. 

Using the JSON interface

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.ucdavis.edu/directory/load?key=myKey&v=1.0

This command performs a bulk load request (/directory/load). The response has a Content-Type of text/javascript.

{
  "responseData" : {
    "results" :Ã? [
{
"checksum": "761156509",
"departmentNumber": "061419",
"eduPersonAffiliation" : "staff",
"cn": "Curtis L Bray",
"givenName": "Curtis",
"sn": "Bray",
"mail" : "clbray@ucdavis.edu",
"ou": "APPLICATION DEVELOPMENT & DATA ADMINISTRATION",
"postalAddress": "3820 Chiles Rd$Davis, CA 95618",
"telephoneNumber" : "+1 530 754 6199",
"l": "Davis",
"postalCode" : "95618",
"street": "3820 Chiles Rd",
"st": "CA",
"title": "Manager",
"displayName": "Curtis Bray"
},
{ .... }
 ],
    "cursor" : {
               "estimatedResultCount": "20102",
               "currentIndex": 0,
               "moreResultsUrl": "https://iet-ws-test.ucdavis.edu/ondir/load?start=500&key=myKey&v=1.0"
               }
  },
  "responseDetails" : null,
  "responseStatus" : 0
}

JSON reference

Unlike the core JavaScript interface, the JSON interface is exposed through a uniform URL that contains CGI arguments. Your application can use an HTTP stack of its choosing. In order to use the JSON interface:

• You must construct a properly formatted URL with all necessary CGI arguments.
• You must send an HTTP referer header that accurately identifies your application.
• You must process the JSON-encoded response.

Request format

URL base address

The standard URL for the IET Middleware Online Directory Bulk Load API is:

https://iet-ws.ucdavis.edu/directory/load

URL arguments

This section describes the arguments that can be used for Bulk Load requests.

The value of a CGI argument must always be properly escaped. This can be done via the functional equivalent of JavaScript's encodeURIComponent() method.

Required URL arguments

The following table lists the required URL arguments.

Optional URL arguments

The following table lists the optional URL arguments.

"cursor" : {
            "estimatedResultCount": "20102",
            "currentIndex": 0,
            "moreResultsUrl": "https://iet-ws.ucdavis.edu/api/load...."
            }

Response format

Each response follow this general format:

{
  "responseData" : {
    "results" : [],
    "cursor" : {}
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 0 | error-code
}

In the JSON fragment above, note that the responseData property contains a results array and an optional cursor.

Results array: guaranteed fields

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

NOTE: All data returned from this API will be filtered to only return records that are not marked private or protected. Each person will have a single result returned that provides their primary listing information along with the first device/address data in that listing. These parameters are based on the LDAP attributes as defined by: Attributes for ou=People,dc=ucdavis,dc=edu.

The responseStatus property contains a value of 0 on success and a custom error status code on failure. If there is a failure, responseDetails contains a diagnostic string.

Trouble shooting

If you encounter problems with your code:

• Make sure your API key is valid.
• Look for typos. Remember that JavaScript is a case-sensitive language.
• Use a JavaScript debugger. In Firefox, you can use the JavaScript console or the Firebug. In IE, you can use the Microsoft Script Debugger.
• If you need to examine the JSON string returned from the server, you can use JSON Lint to make a single, long string human readable.
• Email middleware-api@ucdavis.edu with a description of your problem and a trace of the request and response.