Hole: Started / Finished

Hole Started

Indicates a team has started to play a particular hole.

Hole Started Object

Field Name	Type	Description
seqNum	integer	The sequence number of the packet.
groupId	integer	[Optional] The group ID of the player who did the event
groupNo	integer	The group number of the player who did the event
teamNo	integer	The team number of the player who did the event
holeNo	integer	The hole in which the event took place
holeOrder	integer	The hole order of the hole in which the event took place (e.g. if a player starts a round on hole 10, this will be 1) – always starts at 1 and ends on 18
courseId	integer	The ID of the course where the event took place
timestamp	date	The timestamp of the event, in UTC
timestampReceived	date	The server time of the moment that this packet has been processed
eventElementType	string	The type of event Full list of values include: TglHammerThrown RefereeCalled HoleScoreUpdate Correction ModeChange Penalty RoundStatusUpdate BallDrop ProvisionalBallSelected HitBall AddressingBall ApproximateLie DetailedLie BallHoled
state	object	The type of status update, in this case always Hole Started.
roundNo	integer	The round number

Sample Event Packet:

{
  "courseId": "392",
  "eventElementType": "RoundStatusUpdate",
  "groupId": 1211220,
  "groupNo": 17,
  "holeNo": 10,
  "holeOrder": 1,
  "roundNo": 1,
  "seqNum": 2,
  "state": "HoleStarted",
  "teamNo": 10,
  "timestamp": "2025-02-20T05:17:36.000Z",
  "timestampReceived": "2025-02-20T05:17:36.776Z"
}

Hole Finished

Indicates a team has finished playing a particular hole.

Hole Finished Object

Field Name	Type	Description
seqNum	integer	The sequence number of the packet.
groupId	integer	[Optional] The group ID of the player who did the event
groupNo	integer	The group number of the player who did the event
teamNo	integer	The team number of the player who did the event
holeNo	integer	The hole in which the event took place
holeOrder	integer	The hole order of the hole in which the event took place (e.g. if a player starts a round on hole 10, this will be 1) – always starts at 1 and ends on 18
courseId	integer	The ID of the course where the event took place
timestamp	date	The timestamp of the event, in UTC
eventElementType	string	The type of event Full list of values include: TglHammerThrown RefereeCalled HoleScoreUpdate Correction ModeChange Penalty RoundStatusUpdate BallDrop ProvisionalBallSelected HitBall AddressingBall ApproximateLie DetailedLie BallHoled
state	string	The type of status update, in this case always Hole Finished
finishReason	string	“finishReason” is a string value that explains why a Hole was finished, can be BallHoled, Disqualified, Withdrawn.
roundNo	integer	Round number
score	array	See object below
scorePending	boolean	if score is pending
timestampReceived	date	TThe server time of the moment that this packet has been processed

Score Object

Field Name	Type	Description
currentHolePar	integer	Current hole score
currentHoleStrokes	integer	current strokes on hole
currentRoundScoreToPar	string	Current round to par score
overallScoreToPar	string	overall score

Sample Event Packet:

{
  "courseId": "392",
  "eventElementType": "RoundStatusUpdate",
  "finishReason": "BallHoled",
  "groupId": 1211220,
  "groupNo": 17,
  "holeNo": 10,
  "holeOrder": 1,
  "roundNo": 1,
  "score": {
    "currentHolePar": 5,
    "currentHoleStrokes": 4,
    "currentRoundScoreToPar": "-1",
    "overallScoreToPar": "-1"
  },
  "scorePending": false,
  "": 6,
  "state": "HoleFinished",
  "teamNo": 10,
  "timestamp": "2025-02-20T05:17:36.000Z",
  "timestampReceived": "2025-02-20T05:17:37.892Z"
}

Doc navigation

← Round: Started / Finished / OfficialStandard Stroke Events →