Type Definitions

Overview

Common

Elements that may occur on any TODS object.

• • createdAt? : enum undefined \\ ISO 8601 Date/time string
  • extensions? : enum undefined[]
  • isMock? : enum undefined \\ flag for test data
  • notes? : enum undefined
  • timeItems? : enum undefined[]
  • updatedAt? : enum undefined \\ ISO 8601 Date/time string

Object definitions:

• ▶
  extensionextension
  • description? : enum undefined
  • name: enum undefined
  • value: enum undefined

• ▶
  timeItemObject
  • itemDate? : enum undefined \\ ISO 8601 Date/time string
  • itemSubTypes? : enum undefined[]
  • itemType? : enum undefined
  • itemValue? : enum undefined

---

Generic

Elements that occur on several TODS objects.

• ▶
  addressObject
  • addressLine1? : enum undefined
  • addressLine2? : enum undefined
  • addressLine3? : enum undefined
  • addressName? : enum undefined
  • addressType? : enum
  • city? : enum undefined
  • countryCode? : enum ISO3166-3
  • latitude? : enum undefined \\ 11.583331 or 11°34'59.99 N
  • longitude? : enum undefined \\ 165.333332 or 165°19'60.00 E
  • postalCode? : enum undefined
  • state? : enum undefined
  • timeZone? : enum undefined \\ IANA Code

• ▶
  categoryObject
  • ageCategoryCode? : enum undefined \\ e.g. U12, 12U, C50-70
  • ageMax? : enum undefined
  • ageMaxDate: enum undefined \\ 'YYYY-MM-DD'
  • ageMin? : enum undefined
  • ageMinDate: enum undefined \\ 'YYYY-MM-DD'
  • ballType? : enum
  • categoryName? : enum undefined
  • ratingMax? : enum undefined
  • ratingMin? : enum undefined
  • ratingType? : enum undefined \\ ratings provider
  • subType? : enum undefined \\ e.g. ADULT, JUNIOR, SENIOR
  • type? : enum \\ e.g. AGE, RATING, BOTH

• ▶
  entryObject
  • entryId? : enum undefined \\ id unique within tournament
  • entryPosition? : enum undefined \\ unique within status group
  • entryStage? : enum \\ QUALIFYING or MAIN
  • entryStageSequence? : enum undefined \\ e.g. in progressive qualifying
  • entryStatus? : enum \\ e.g. DIRECT_ACCEPTANCE, ALTERNATE
  • participantId: enum undefined

• ▶
  onlineResourceObject
  • identifier? : enum undefined \\ e.g. resource URL, email address
  • name? : enum undefined
  • provider? : enum undefined \\ e.g. Twitter
  • resourceSubType? : enum undefined \\ e.g. PDF, IMAGE, WEBSITE
  • resourceType? : enum \\ e.g. URL, EMAIL, SOCIAL_MEDIA

---

tournament

• ▶
  tournamentObject
  • endDate: enum undefined \\ 'YYYY-MM-DD'
  • events? : enum undefined[]
  • formalName? : enum undefined
  • hostCountryCode? : enum ISO3166-3
  • indoorOutdoor? : enum
  • localTimeZone? : enum undefined
  • matchUps? : enum undefined[]
  • onlineResources? : enum undefined[]
  • parentOrganizationid? : enum undefined
  • participants? : enum undefined[]
  • promotionalName? : enum undefined
  • registrationProfile? : enum undefined
  • season? : enum undefined \\ e.g. 'Fall 2020'
  • startDate: enum undefined \\ 'YYYY-MM-DD'
  • surfaceCategory? : enum
  • totalPrizeMoney? : enum undefined[]
  • tournamentCategories? : enum undefined[]
  • tournamentGroups? : enum undefined[] \\ e.g. ['Grand Slam']
  • tournamentId: enum undefined
  • tournamentLevel? : enum
  • tournamentName: enum undefined
  • tournamentOtherIds? : enum undefined[]
  • tournamentRank? : enum undefined \\ unique to provider
  • venues? : enum undefined[]

• ▶
  registrationProfileObject
  • entriesClose: enum undefined \\ 'YYYY-MM-DD'
  • entriesOpen: enum undefined \\ 'YYYY-MM-DD'
  • withdrawalDeadline: enum undefined \\ 'YYYY-MM-DD'

---

participant

• ▶
  participantObject
  • contacts? : enum undefined[]
  • individualParticipantIds? : enum undefined[] \\ participantIds in TEAM, GROUP, or PAIR
  • onlineResources? : enum undefined[]
  • participantId: enum undefined
  • participantName? : enum undefined
  • participantOtherName? : enum undefined
  • participantRole? : enum \\ e.g. COMPETITOR, OFFICIAL, COACH
  • participantRoleResponsibilities? : enum undefined[]
  • participantStatus? : enum
  • participantType? : enum \\ e.g. INDIVIDUAL, PAIR, TEAM, GROUP
  • penalties? : enum undefined[]
  • person? : enum undefined
  • representing? : enum ISO3166-3
  • teamId? : enum undefined \\ if participant is TEAM; provider specific

• ▶
  penaltyObject
  • issuedAt? : enum undefined \\ ISO 8601 Date/time string
  • matchUpId? : enum undefined
  • penaltyCode? : enum undefined \\ provider specific
  • penaltyId? : enum undefined \\ unique identifier within tournament
  • penaltyType? : enum
  • refereeParticipantId? : enum undefined \\ participantId of official

• ▶
  personObject
  • addresses? : enum undefined[]
  • biographicalInformation? : enum undefined[]
  • birthDate: enum undefined \\ 'YYYY-MM-DD'
  • contacts? : enum undefined[]
  • nationalityCode? : enum ISO3166-3
  • nativeFamilyName? : enum undefined
  • nativeGivenName? : enum undefined
  • onlineResources? : enum undefined[]
  • otherNames? : enum undefined[]
  • parentOrganisationId? : enum undefined
  • passportFamilyName? : enum undefined
  • passportGivenName? : enum undefined
  • personId? : enum undefined
  • personOtherIds? : enum undefined[]
  • previousNames? : enum undefined[]
  • sex? : enum
  • standardFamilyName? : enum undefined
  • standardGivenName? : enum undefined
  • tennisId? : enum undefined
  • wheelchair? : enum undefined

• ▶
  biographicalInformationObject
  • ageBeganTennis? : enum undefined
  • ageTurnedPro? : enum undefined
  • birthCountryCode? : enum ISO3166-3
  • coachId? : enum undefined
  • doublePlayingHand? : enum
  • height? : enum undefined
  • heightUnit? : enum
  • organisationIds? : enum undefined[]
  • placeOfResidence? : enum undefined
  • playingHand? : enum
  • residenceCountryCode? : enum ISO3166-3
  • weight? : enum undefined
  • weightUnit? : enum

---

event

• ▶
  eventObject
  • category? : enum undefined[]
  • discipline? : enum
  • drawDefinitions? : enum undefined[]
  • endDate: enum undefined \\ 'YYYY-MM-DD'
  • entries? : enum undefined[]
  • eventId: enum undefined
  • eventLevel? : enum
  • eventName? : enum undefined
  • eventRank? : enum undefined
  • eventType: enum \\ SINGLES, DOUBLES, or TEAM
  • gender? : enum
  • indoorOutdoor? : enum
  • links? : enum undefined[]
  • matchUpFormat? : enum undefined \\ TODS matchup format, e.g. 'SET3-S:6/TB7'
  • startDate: enum undefined \\ 'YYYY-MM-DD'
  • surfaceCategory? : enum
  • tennisOfficialIds? : enum undefined[] \\ participantId array
  • tieFormat? : enum undefined
  • wheelchairClass? : enum

---

drawDefinition

• ▶
  drawDefinitionObject
  • automated? : enum undefined
  • drawId: enum undefined
  • drawName? : enum undefined
  • drawOrder? : enum undefined
  • drawRepresentativeIds? : enum undefined[] \\ participantId array
  • drawStatus: enum
  • drawType? : enum
  • endDate: enum undefined \\ 'YYYY-MM-DD'
  • entries? : enum undefined[]
  • links? : enum undefined[]
  • matchUpFormat? : enum undefined \\ TODS matchup format, e.g. 'SET3-S:6/TB7'
  • matchUps? : enum undefined[]
  • startDate: enum undefined \\ 'YYYY-MM-DD'
  • structures? : enum undefined[]
  • tieFormat? : enum undefined

• ▶
  structurestructure
  • finishingPosition? : enum \\ e.g. ROUND_OUTCOME, WIN_RATION
  • matchUpFormat? : enum undefined \\ TODS matchup format, e.g. 'SET3-S:6/TB7'
  • matchUps? : enum undefined[]
  • positionAssignments? : enum undefined
  • seedAssignments? : enum undefined
  • seedLimit? : enum undefined \\ Maximum # allowed seeds
  • seedingProfile? : enum \\ e.g. WATERFALL for round robin structures
  • stage? : enum undefined \\ e.g. MAIN, CONSOLATION
  • stageSequence? : enum undefined
  • structureAbbreviation? : enum undefined \\ used in construction of roundNames
  • structureId: enum undefined \\ id unique within drawDefinition
  • structureName? : enum undefined \\ e.g. North, South for Compass Draws
  • structureType? : enum undefined \\ CONTAINER or ITEM
  • structures? : enum undefined[] \\ Contained structures, e.g. round robin groups
  • tieFormat? : enum undefined

• ▶
  seedAssignmentObject
  • participantId: enum undefined
  • seedNumber: enum undefined \\ unique integer
  • seedValue? : enum undefined \\ e.g. 5-8

• ▶
  positionAssignmentObject
  • bye? : enum undefined
  • drawPosition: enum undefined
  • participantId: enum undefined
  • qualifier? : enum undefined

• ▶
  linkObject
  • linkCondition? : enum \\ e.g. FIRST_MATCHUP
  • linkType: enum \\ WINNER or LOSER
  • source: enum undefined
  • target: enum undefined

• ▶
  linkSourceObject
  • drawId? : enum undefined \\ if target is in different draw
  • finishingPositions? : enum undefined[] \\ round robin final positions
  • roundNumber: enum undefined \\ if target is in different draw
  • structureId: enum undefined \\ target structure

• ▶
  linkTargetObject
  • drawId? : enum undefined \\ if target is in different draw
  • feedProfile: enum \\ e.g. TOP_DOWN, BOTTOM_UP
  • groupedOrder? : enum undefined[] \\ relates to fed positions
  • positionInterleave? : enum undefined \\ e.g. double elimination backdraw
  • roundNumber: enum undefined \\ if target is in different draw
  • structureId: enum undefined \\ target structure

• ▶
  interleaveObject
  • interleave: enum undefined \\ # of positions to skip between fed positions
  • offset: enum undefined \\ # of positions to skip before beginning

---

matchUp

A matchUp is an object which contains the details of an encounter between two tournament participants, which can be INDIVIDUALS, PAIRS, or TEAMS. The term matchUp was chosen to differentiate from other interpretations, particularly in the context of software development, of the more traditional term "match". Other descriptive terms such as "face off" and "throw down" were never seriously considered.

• ▶
  matchUpObject
  • collectionId? : enum undefined \\ only applies to tieMatchUps
  • collectionPosition? : enum undefined \\ only applies to tieMatchUps
  • drawPositions? : enum undefined[]
  • endDate: enum undefined \\ 'YYYY-MM-DD'
  • finishingPositionRange? : enum undefined
  • finishingRound? : enum undefined
  • indoorOutdoor? : enum
  • loserMatchUpId? : enum undefined
  • matchUpDuration? : enum undefined
  • matchUpFormat? : enum undefined \\ TODS matchup format, e.g. 'SET3-S:6/TB7'
  • matchUpId: enum undefined
  • matchUpStatus: enum
  • matchUpStatusCodes? : enum undefined[] \\ provider specific
  • matchUpType: enum \\ SINGLES, DOUBLES, or TEAM
  • orderOfFinish? : enum undefined
  • roundName? : enum undefined
  • roundNumber? : enum undefined
  • roundPosition? : enum undefined
  • score? : enum undefined
  • sides? : enum undefined
  • startDate: enum undefined \\ 'YYYY-MM-DD'
  • surfaceCategory? : enum
  • tieFormat? : enum undefined
  • tieMatchUps? : enum undefined[]
  • winnerMatchUpId? : enum undefined
  • winningSide? : enum undefined \\ 1 or 2

• ▶
  positionRangeObject
  • loser: enum undefined[] \\ e.g. [3, 4] would be the result of a SemiFinal loss
  • winner: enum undefined[] \\ e.g. [1, 2] would be the result of a SemiFinal win

• ▶
  scoreObject
  • scoreStringSide1? : enum undefined \\ score from sideNumber 1 perspective
  • scoreStringSide2? : enum undefined \\ score from sideNumber 2 perspective
  • sets? : enum undefined[]

• ▶
  setObject
  • games? : enum undefined[]
  • setDuration? : enum undefined \\ duration in minutes
  • setNumber? : enum undefined
  • side1PointScore? : enum undefined
  • side1Score? : enum undefined
  • side1TiebreakScore? : enum undefined
  • side2PointScore? : enum undefined
  • side2Score? : enum undefined
  • side2TiebreakScore? : enum undefined
  • winningSide? : enum undefined \\ 1 or 2

• ▶
  sideObject
  • lineUp? : enum undefined[]
  • participantId: enum undefined
  • sideNumber? : enum undefined \\ 1 or 2

• ▶
  teamCompetitorObject
  • collectionAssignments? : enum undefined[]
  • participantId: enum undefined \\ must be an individual participantId

• ▶
  collectionAssignmentObject
  • collectionId: enum undefined
  • collectionPosition: enum undefined

---

tieFormat

See tieFormats Explanation.

• ▶
  tieFormatObject
  • collectionDefinitions: enum undefined[]
  • collectionGroups? : enum undefined[]
  • tieFormatName? : enum undefined
  • winCriteria: enum undefined

• ▶
  collectionDefinitionObject
  • collectionGroupNumber? : enum undefined
  • collectionId: enum undefined
  • collectionName? : enum undefined
  • collectionValue? : enum undefined
  • collectionValueProfiles: enum undefined[]
  • matchUpCount: enum undefined
  • matchUpFormat? : enum undefined \\ TODS matchup format, e.g. 'SET3-S:6/TB7'
  • matchUpType: enum \\ SINGLES, DOUBLES, or TEAM
  • matchUpValue? : enum undefined
  • scoreValue? : enum undefined
  • setValue? : enum undefined
  • winCriteria: enum undefined

• ▶
  collectionGroupObject
  • groupName? : enum undefined
  • groupNumber: enum undefined

• ▶
  collectionValueProfiles[]
  • ▶
    0Object

• ▶
  winCriteriaObject
  • valueGoal: enum undefined \\ Value required to win the matchUp

---

venue

• ▶
  venueObject
  • addresses? : enum undefined[]
  • contacts? : enum undefined[]
  • courts? : enum undefined[]
  • onlineResources? : enum undefined[]
  • parentOrganisationId? : enum undefined
  • roles? : enum undefined[] \\ e.g. courts, sign-in, hospitality
  • subVenueIds? : enum undefined[]
  • venueAbbreviation? : enum undefined
  • venueId: enum undefined
  • venueName? : enum undefined
  • venueOtherIds? : enum undefined[]
  • venueType? : enum undefined

• ▶
  courtObject
  • altitude? : enum undefined
  • courtDimensions? : enum undefined
  • courtId: enum undefined
  • courtName? : enum undefined
  • dateAvailability? : enum undefined[]
  • latitude? : enum undefined
  • longitude? : enum undefined
  • onlineResources? : enum undefined[]
  • pace? : enum undefined
  • surfaceCategory? : enum
  • surfaceType? : enum undefined \\ ITF recognized type
  • surfacedDate: enum undefined \\ 'YYYY-MM-DD'

• ▶
  availabilityObject
  • bookings? : enum undefined[]
  • date: enum undefined \\ 'YYYY-MM-DD'
  • endTime: enum undefined \\ 24 Hour format: '00:00'
  • startTime: enum undefined \\ 24 Hour format: '00:00'

• ▶
  bookingObject
  • bookingType: enum undefined \\ e.g. 'practice', 'maintenance'
  • endTime: enum undefined \\ 24 Hour format: '00:00'
  • startTime: enum undefined \\ 24 Hour format: '00:00'