Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width20%
Panel
borderColor#BF9900
bgColor#FFFFFF
titleBGColor#E5D699
titleIn this Section
borderStylesolid
Table of Contents
indent15px
stylenone
Column

Overview

These APIs provide a basic search and bulk load API for data that is publish published from the Online Directory system. If you need assistance with these this APIs, please email middleware-api@ucdavis.edu.

Audience

Excerpt

This documentation is intended for developers who wish to search perform a bulk download of the public data within the Online Directory system from within their application via the REST with JSON interface.

This is currently the only interface available for these APIsthis 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.

Code Block
titleSample JSON Request
curl -i -H "Accept: application/json" https://iet-ws-test/ondirdirectory/load?key=JPO3Dkljsd3Skjkdxxo3SJK00&v=1.0

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

Code Block
langxml
titleSample JSON Response
{
  "responseData" : {
    "results" : [ {"firstName":"Curtis","lastName":"Bray","phone":"754-6199","deptNum":12345} ],
    "cursor" : {
               "estimatedResultCount": "20102",
               "currentIndex": 0,
               "moreResultsUrl": "https://iet-ws-test/ondir/load?istart=500"
               }
  },
  "responseDetails" : null,
  "responseStatus" : 200
}

JSON reference

Request format

Response format

Each response follow this general format:

Code Block
langxml
{
  "responseData" : {
    "results" : [],
    "cursor" : {}
  },
  "responseDetails" : null | string-on-error,
  "responseStatus" : 200 | error-code
}

Trouble shooting