THthebluealliance
event

GET /event/{event_key}/simple

Changed on

Gets a short-form Event.

Request

  • Base URL
    https://www.thebluealliance.com/api/v3
  • Auth
    API key in header X-TBA-Auth-Key

Path parameters

event_keystring required

TBA Event Key, eg 2016nytr

Headers

If-None-Matchstring

Value of the ETag header in the most recently cached response by the client.

Response

Successful response

keystring required

TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.

namestring required

Official name of event on record either provided by FIRST or organizers of offseason event.

event_codestring required

Event short code, as provided by FIRST.

event_type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 99 | 100 | -1 required

Event Type. See https://github.com/the-blue-alliance/the-blue-alliance/blob/main/src/backend/common/consts/event_type.py for definitions.

citystring nullable required

City, town, village, etc. the event is located in.

state_provstring nullable required

State or Province the event is located in.

countrystring nullable required

Country the event is located in.

start_datestring date required

Event start date in yyyy-mm-dd format.

end_datestring date required

Event end date in yyyy-mm-dd format.

yearinteger required

Year the event data is for.

Changes

  • c26cc01880d2Revision changes
    • warning

      added the new -1.00 enum value to the response property for the response status

    • warning

      added the new 0.00 enum value to the response property for the response status

    • warning

      added the new 1.00 enum value to the response property for the response status

    • warning

      added the new 100.00 enum value to the response property for the response status

    • warning

      added the new 2.00 enum value to the response property for the response status

    • warning

      added the new 3.00 enum value to the response property for the response status

    • warning

      added the new 4.00 enum value to the response property for the response status

    • warning

      added the new 5.00 enum value to the response property for the response status

    • warning

      added the new 6.00 enum value to the response property for the response status

    • warning

      added the new 7.00 enum value to the response property for the response status

    • warning

      added the new 99.00 enum value to the response property for the response status

  • e02edcb016b7Revision changes
    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from null object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status