OverviewThese APIs provide a bulk load API for data that is published from the Online Directory system. If you need assistance with this APIs, please email middleware-api@ucdavis.edu. Audience Excerpt |
---|
This documentation is intended for developers who wish to 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 this API. If you would like to see an XML interface please email middleware-api@ucdavis.edu. Application requirementsEach 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 interfaceThe 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 |
---|
| curl -i -H "Accept: application/json" https://iet-ws-test/directory/load?key=JPO3Dkljsd3Skjkdxxo3SJK00&v=1.0 |
This command performs a bulk load request (/directory/load). The response has a Content-Type of text/javascript. Code Block |
---|
lang | xml |
---|
title | Sample 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?start=500"
}
},
"responseDetails" : null,
"responseStatus" : 200
}
|
JSON referenceEach response follow this general format: Code Block |
---|
|
{
"responseData" : {
"results" : [],
"cursor" : {}
},
"responseDetails" : null | string-on-error,
"responseStatus" : 200 | error-code
}
|
Trouble shooting |