JSON reference
Application requirements
Each request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>.
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/api/directory/search
URL arguments
This section describes the arguments that can be used for search 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.
Argument |
Example |
Description |
---|---|---|
key |
key=your-key |
This argument supplies the application's key. You can sign up for an API key <INSERT LINK HERE>. |
v |
v=1.0 |
This argument supplies protocol version number. The only valid value at this point in time is 1.0. |
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.