Documentation

API Calls

API Parameters and Their Inputs

Here is a table of all API Parameters and their accepted inputs excluding the Terms parameter due to its variability. The Terms (terms=) parameter is best exemplified in the Common API Calls Breakdown section. An example of an API call would look like this: https://cordova.eng.uiowa.edu/api?version=9&type=gvtable&method=download&format=csv&terms=GJB2

Version (version=) 9

Type (type=) gvtable gene position hg38coord

Method (method=) download exists IO

Format (format=) csv json bool tab web

Explanation of API Parameters

• Version: Used to specify the version to query for the API call.
• Type: Used to specify the kind of data to be targeted with the API call.
• Method: Used to specify how the data should be delivered to the requester.
• Format: Used to specify the organization of the data returned by the API call.

API Call Return Format

API calls return a JSON object that may be different depending on the type of success or failure of an API call. In general, the returned JSON object is formed as follows:

        {
            "title": "API Query status message",
            "api_terms": {
                "api": "",
                "version": "9",
                "type": "type parameter input",
                "method": "method parameter input",
                "format": "format parameter input",
                "terms": "terms parameter input"
            },
            "message": ["result messages as a list of strings"],
            "content": "returned data"
        }