TBAApi.md

TBAAPI.V3Client.Api.TBAApi

All URIs are relative to https://www.thebluealliance.com/api/v3

Method	HTTP request	Description
GetStatus	GET /status

GetStatus

APIStatus GetStatus (string ifModifiedSince = null)

Returns API status, and TBA status information.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;

namespace Example
{
    public class GetStatusExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            config.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new TBAApi(config);
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                APIStatus result = apiInstance.GetStatus(ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TBAApi.GetStatus: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ifModifiedSince	string	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

APIStatus

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly. * Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.
304	Not Modified - Use Local Cached Value	-
401		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]