OverviewThese APIs provide a basic search and bulk load API for data that is publish from the Online Directory system. If you need assistance with these APIs, please email middleware-api@ucdavis.edu. Audience Excerpt |
---|
This documentation is intended for developers who wish to search the Online Directory system from within their application via the REST with JSON interface. |
This is currently the only interface available for these APIs. If you would like to see an XML interface please email middleware-api@ucdavis.edu. Application requirementsUsing 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" httphttps://iet-ws-test/ondir/load |
This command performs a bulk load request (/ondir/load). The response has a Contenta 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?i=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 |