Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.08 KB

Award.md

File metadata and controls

25 lines (18 loc) · 1.08 KB

TBA API v3 Ruby Client::Award

Properties

Name Type Description Notes
name String The name of the award as provided by FIRST. May vary for the same award type.
award_type Integer Type of award given. See https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/award_type.py#L6
event_key String The event_key of the event the award was won at.
recipient_list Array<AwardRecipient> A list of recipients of the award at the event. May have either a team_key or an awardee, both, or neither (in the case the award wasn't awarded at the event).
year Integer The year this award was won.

Code Sample

require 'TBA API v3 Ruby Client'

instance = TBA API v3 Ruby Client::Award.new(name: null,
                                 award_type: null,
                                 event_key: null,
                                 recipient_list: null,
                                 year: null)