action thebluealliance_get_event_rankings {
  label: "getEventRankings"
  description: "Gets a list of team rankings for the Event."
  provider: thebluealliance
  method: GET
  path: "/event/{event_key}/rankings"
  encoding: json
  output: {
    type: "object"
    required: ["rankings", "sort_order_info"]
    properties: {
      extra_stats_info: {
        type: "array"
        description: "List of special TBA-generated values provided in the `extra_stats` array for each item."
        items: {
          type: "object"
          required: ["name", "precision"]
          properties: {
            name: {
              type: "string"
              description: "Name of the field used in the `extra_stats` array."
            }
            precision: {
              type: "number"
              description: "Integer expressing the number of digits of precision in the number provided in `sort_orders`."
            }
          }
        }
      }
      rankings: {
        type: "array"
        description: "List of rankings at the event."
        items: {
          type: "object"
          required: ["dq", "matches_played", "rank", "record", "team_key"]
          properties: {
            dq: {
              type: "integer"
              description: "Number of times disqualified."
            }
            extra_stats: {
              type: "array"
              description: "Additional special data on the team's performance calculated by TBA."
              items: {
                type: "number"
              }
            }
            matches_played: {
              type: "integer"
              description: "Number of matches played by this team."
            }
            qual_average: {
              type: "integer"
              description: "The average match score during qualifications. Year specific. May be null if not relevant for a given year."
            }
            rank: {
              type: "integer"
              description: "The team's rank at the event as provided by FIRST."
            }
            record: {
              type: "object"
              description: "A Win-Loss-Tie record for a team, or an alliance."
              required: ["losses", "ties", "wins"]
              properties: {
                losses: {
                  type: "integer"
                  description: "Number of losses."
                }
                ties: {
                  type: "integer"
                  description: "Number of ties."
                }
                wins: {
                  type: "integer"
                  description: "Number of wins."
                }
              }
            }
            sort_orders: {
              type: "array"
              description: "Additional year-specific information, may be null. See parent `sort_order_info` for details."
              items: {
                type: "number"
              }
            }
            team_key: {
              type: "string"
              description: "The team with this rank."
            }
          }
        }
      }
      sort_order_info: {
        type: "array"
        description: "List of year-specific values provided in the `sort_orders` array for each team."
        items: {
          type: "object"
          required: ["name", "precision"]
          properties: {
            name: {
              type: "string"
              description: "Name of the field used in the `sort_order` array."
            }
            precision: {
              type: "integer"
              description: "Integer expressing the number of digits of precision in the number provided in `sort_orders`."
            }
          }
        }
      }
    }
  }
}