Operations related to access and security for the Unknown Golf API

Expiration: Security token expires after 24 hours

Operations for Communities

What is a Community? A community in Unknown Golf is an entity that will group together all of your players and events.

What is a Club? A club is also a community, the main difference is that a club has sub communities and a club dashboard that provides insight into all of the Club's players and events.

Operations related to the Events in your community (or Club)

Event Types: A tournament refers to a Multi-Round Event that has rounds (events) associated with it. These events have their event ids prefixed with the letter "M", a single round event or a round of a multi-round will have their event ids prefixed with the letter "S".

Creating an Event: Events can only be created on UnknownGolf.com, they currently cannot be created through the Unknwon Golf API.

Operations related to the Flights for an event.

Each leaderboard has its own set of flights which can be used for the following:

1. Segment your leaderboards into groups by Handicap, Age, Course, etc....
2. Determine if players or teams are participating in a Leaderboard. If a leaderboard has flights defined, a player or team is not assigned to a flight, then they are not participating in that leaderboard and will not show up in the standings or results for that leaderboard.

** Are Flights Required?** Single round events contain a setting to enable or disable flights, currently ALL multi-round events require flights, although this option is targeted to be added in the future.

Players: Players must be signed up for the event to be assigned to a flight.

Operations related to Player Handicaps for an Event

Multi-Round Handicaps: For multi-round events, the player's will have handicaps set at the overall event level and then for each round which will override the event level for that round.

Course vs. Playing Handicap: The "Course Handicap" is the players calculated handicap for the assigned tee box (Slope, Rating, and Par).

The "Playing Handicap" is the player's course handicap and then applying allocations, an example allocation could be 80% of a player's handicap where their Course handicap is a 10 and their playing handicap is an 8.

Applying Allocations: Allocations are applied to the unrounded course handicap wich may result is 2 players having the same course handicap but slightly different playing handicaps.

Handicap Number of Holes: All handicaps consumed and calculated are for 18 holes, regardless of the number of holes that are being played. If you are manually setting a handicap for an event that is playing less then 18 holes, ensure you are setting an 18 hole equilivant handicap for the player.

Operations related to Team Handicaps for an Event

Multi-Round Events: When setting a team handicap for a multi-round event, the handicap should be set for each round of the event, there is no option to set a team handicap for the entire event.

Course vs. Playing Handicap: The "Course Handicap" is the team's calculated handicap for their players.

The "Playing Handicap" is the team's course handicap and then applying allocations, an example allocation could be 50% of a team's total handicap, where their Course handicap is a 10 and their playing handicap is an 5.

Applying Allocations: Allocations are applied to the unrounded course handicap which may result is 2 teams having the same course handicap but slightly different playing handicaps.

Handicap Number of Holes: All handicaps consumed and calculated are for 18 holes, regardless of the number of holes that are being played. If you are manually setting a handicap for an event that is playing less than 18 holes, ensure you are setting an 18 hole equivalent handicap for the team.

Operations related to the Leaderboards for an event.

A Leaderboard defines the format of play and payouts, and contains multiple different configurations per leaderboard type.

Multi-Round Events: For multi-round events, the set of leaderboards are created for each round of the event, in addition to the overall set of leaderboards.

Leaderboards set at the "round level" will define the format and payouts for just that round, where the leaderboards set at the "event level" will define the format and payouts for the entire event, inclusive of all rounds unless configured for a subset of rounds.

Add / Edit Leaderboard Configurations: Add and editing of leaderboards can only be done on UnknownGolf.com

List of Leaderboard types: Reference the Utility opertation "/util/leaderboards/types" for a full list of leaderboard types, additional information on the leaderboard types can be found in Unknown Golf's help documentation (help.UnknownGolf.com).

Operations related to Players registering to participate in an Event

Player Types: Players registered for your Event can be registed by their Profile, or by their name and Gender.

Multi-Round Event vs. Single Round: For multi-round events, players are registered for the Multi-round, they are not registered individually for each round.

Note: Players registered by name will not have any communication method associated with them, and will not be able to be included in any reports other then this event.

Operations related to the Team Scores for an event.

Note: This is for Team Scores where the format of play is to enter a single score per hole for a team, this is not for events where individual player scores are entered and then combined to create a team score.

Operations related to the Teams for your Events

Players: Players must be signed up for the event to be assigned to a team.

Note: If an event is a multi-round, there can be teams for the overall event and also a different set of teams for each round

Operations related to the Tee Pairings for an event.

Players: Players must be signed up for the event to be assigned to a tee pairing.

Course: Tee pairings are unique by golf course

Tee Group: The tee group is used to define the order of tee groups starting on the same hole at the same time. An examle is having an "A" and "B" group both starting on hole 1 at 8:00 AM. The "A" group would tee off first followed by the "B" group.

Operations to retrieve web links for your Events

Note: Some weblinks can be created specificially for a player and should only be shared with that player, while others are generic and can be shared with anyone.

Operations related to the Players in your community (or Club)

Security: You only have access to players that are in your community(s).

Player Updates: Once a player completes their profile on UnknownGolf.com, there are personal attributes that you cannot update, only the player themselves can make the updates on UnknownGolf.com

Duplicate Profiles & Merging Accounts: A unique profile is determined by a Unique Email Address or Unique World Handicap Id, if you receive an error message when adding (or updating) a player you will need to reach out to Support@UnknownGolf.com to have the profiles merged.