Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 3.21 KB

TBAApi.md

File metadata and controls

87 lines (63 loc) · 3.21 KB

tbaapiv3client.TBAApi

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

Method HTTP request Description
get_status GET /status

get_status

APIStatus get_status(if_modified_since=if_modified_since)

Returns API status, and TBA status information.

Example

  • Api Key Authentication (apiKey):
from __future__ import print_function
import time
import tbaapiv3client
from tbaapiv3client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://www.thebluealliance.com/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = tbaapiv3client.Configuration(
    host = "https://www.thebluealliance.com/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration = tbaapiv3client.Configuration(
    host = "https://www.thebluealliance.com/api/v3",
    api_key = {
        'X-TBA-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with tbaapiv3client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tbaapiv3client.TBAApi(api_client)
    if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

    try:
        api_response = api_instance.get_status(if_modified_since=if_modified_since)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TBAApi->get_status: %s\n" % e)

Parameters

Name Type Description Notes
if_modified_since str 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]