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
state
object
The type of status update, in this case always Hole Started.
roundNo
integer
The round number
Sample Event Packet:
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
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:
← Round: Started / Finished / OfficialStandard Stroke Events →