Other Functions

Below is a list of Other Functions located in the Other Functions.js file.

Click on a function heading and it shows the TBA Equivalent along with all the details.

getStatus

/**
 * Returns API status, and TBA Status information.
 * 
 * @param {String}
 *            header - optional header if requesting specific info - consult TBA
 *            API.
 * @param {Boolean}
 *            raw - optional config for raw JSON output instead of preformatted
 *            array. Will not output to cells
 * @returns {Array} returns API status, and TBA Status information
 */
function getStatus(header, raw) {...}

apiDataCall

/**
 * Call The Blue Alliance API.
 * 
 * @param {String}
 *            endpoint - endpoint to the requested data - consult TBA API for
 *            valid endpoints.
 * @param {String}
 *            query - optional header if requesting specific info inside
 *            endpoint - consult TBA API.
 * @param {Boolean}
 *            raw - optional config for raw JSON output instead of preformatted
 *            array. Will not output to cells
 * @returns {Array} returns requested data in array form.
 */
function apiDataCall(endpoint, query, raw) {...}

In this file, there is also private functions called getKey_() and getURL_(). In the getKey_() function, you must place your TBA API Auth Key after the equals sign shown below

?X-TBA-Auth-Key=[YOUR-KEY]

Back to Home