action thebluealliance_get_district_events {
  label: "getDistrictEvents"
  description: "Gets a list of events in the given district."
  provider: thebluealliance
  method: GET
  path: "/district/{district_key}/events"
  encoding: json
  output: {
    type: "array"
    items: {
      type: "object"
      required: ["end_date", "event_code", "event_type", "event_type_string", "key", "name", "start_date", "year"]
      properties: {
        address: {
          type: "string"
          description: "Address of the event's venue, if available."
        }
        city: {
          type: "string"
          description: "City, town, village, etc. the event is located in."
        }
        country: {
          type: "string"
          description: "Country the event is located in."
        }
        district: {
          type: "object"
          required: ["abbreviation", "display_name", "key", "year"]
          properties: {
            abbreviation: {
              type: "string"
              description: "The short identifier for the district."
            }
            display_name: {
              type: "string"
              description: "The long name for the district."
            }
            key: {
              type: "string"
              description: "Key for this district, e.g. `2016ne`."
            }
            year: {
              type: "integer"
              description: "Year this district participated."
            }
          }
        }
        division_keys: {
          type: "array"
          description: "An array of event keys for the divisions at this event."
          items: {
            type: "string"
          }
        }
        end_date: {
          type: "string"
          format: "date"
          description: "Event end date in `yyyy-mm-dd` format."
        }
        event_code: {
          type: "string"
          description: "Event short code, as provided by FIRST."
        }
        event_type: {
          type: "integer"
          description: "Event Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2"
        }
        event_type_string: {
          type: "string"
          description: "Event Type, eg Regional, District, or Offseason."
        }
        first_event_code: {
          type: "string"
          description: "Public facing event code used by FIRST (on frc-events.firstinspires.org, for example)"
        }
        first_event_id: {
          type: "string"
          description: "The FIRST internal Event ID, used to link to the event on the FRC webpage."
        }
        gmaps_place_id: {
          type: "string"
          description: "Google Maps Place ID for the event address."
        }
        gmaps_url: {
          type: "string"
          format: "url"
          description: "Link to address location on Google Maps."
        }
        key: {
          type: "string"
          description: "TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event."
        }
        lat: {
          type: "number"
          format: "double"
          description: "Latitude for the event address."
        }
        lng: {
          type: "number"
          format: "double"
          description: "Longitude for the event address."
        }
        location_name: {
          type: "string"
          description: "Name of the location at the address for the event, eg. Blue Alliance High School."
        }
        name: {
          type: "string"
          description: "Official name of event on record either provided by FIRST or organizers of offseason event."
        }
        parent_event_key: {
          type: "string"
          description: "The TBA Event key that represents the event's parent. Used to link back to the event from a division event. It is also the inverse relation of `divison_keys`."
        }
        playoff_type: {
          type: "integer"
          description: "Playoff Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/playoff_type.py#L4, or null."
        }
        playoff_type_string: {
          type: "string"
          description: "String representation of the `playoff_type`, or null."
        }
        postal_code: {
          type: "string"
          description: "Postal code from the event address."
        }
        short_name: {
          type: "string"
          description: "Same as `name` but doesn't include event specifiers, such as 'Regional' or 'District'. May be null."
        }
        start_date: {
          type: "string"
          format: "date"
          description: "Event start date in `yyyy-mm-dd` format."
        }
        state_prov: {
          type: "string"
          description: "State or Province the event is located in."
        }
        timezone: {
          type: "string"
          description: "Timezone name."
        }
        webcasts: {
          type: "array"
          items: {
            type: "object"
            required: ["channel", "type"]
            properties: {
              channel: {
                type: "string"
                description: "Type specific channel information. May be the YouTube stream, or Twitch channel name. In the case of iframe types, contains HTML to embed the stream in an HTML iframe."
              }
              date: {
                type: "string"
                description: "The date for the webcast in `yyyy-mm-dd` format. May be null."
              }
              file: {
                type: "string"
                description: "File identification as may be required for some types. May be null."
              }
              type: {
                type: "string"
                description: "Type of webcast, typically descriptive of the streaming provider."
                enum: ["youtube", "twitch", "ustream", "iframe", "html5", "rtmp", "livestream", "direct_link", "mms", "justin", "stemtv", "dacast"]
              }
            }
          }
        }
        website: {
          type: "string"
          description: "The event's website, if any."
        }
        week: {
          type: "integer"
          description: "Week of the event relative to the first official season event, zero-indexed. Only valid for Regionals, Districts, and District Championships. Null otherwise. (Eg. A season with a week 0 'preseason' event does not count, and week 1 events will show 0 here. Seasons with a week 0.5 regional event will show week 0 for those event(s) and week 1 for week 1 events and so on.)"
        }
        year: {
          type: "integer"
          description: "Year the event data is for."
        }
      }
    }
  }
}