{
"responseStatus" : 0,
"responseDetails" : null,
"majorCodeList" :
[
{
"count" : 250,
"code" : "AABI"
},
{
"count" : 26,
"code" : "AAEE"
},
{ .... }
]
}
|
JSON referenceThe 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.
URL base address The standard URL for the Major Lookup API is: https://iet-ws.ucdavis.edu/api/mothra/MajorCodes/v1.0 URL argumentsThis section describes the arguments that can be used for Major Lookup 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 argumentsThe 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>. It must be a valid key associated with your application. The key is required for this API to implement quality of service rules for this API. If your application is making too many requests it will be throttled to ensure resources are not overloaded during times of peak usage. Also, by supplying a key we can identify and contact you should something go wrong with your application. |
Response format Each response follow this general format: |