Provision Ball Selected
This event will be sent following when a player hits a provisional ball – it will indicate which of the provisional balls was chosen and how the player will continue their round.
Will be the event that follows any stroke events that have the provisionalIndex NOT set to 0.
ProvisionalBallSelected Object
Field Name
Type
Description
seqNum
int
The sequence number of the packet. Always starts at 1, increments in 1
groupNo
int
[Optional] The group ID of the player who did the event
teamNo
int
The team ID of the player who did the event
playerId
int
The player ID of the player who did the event
holeNo
int
The hole in which the event took place
holeOrder
int
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
int
The ID of the course where the event took place
strokeNo
int
The stroke associated with the event
timestamp
date
The timestamp of the event, in UTC
eventElementType
string
The type of event, in this case ProvisionalBallSelected
provisionalIndex
int
indicates if the event is part of a provisional ball. 0 if not, 1 if first provisional ball, 2 if second provisional ball for that stroke, e.t.c…
penaltyStrokes
int
The number of penalty strokes attributed to that particular provisional ball that was selected
provisionalResult
int
the number of strokes assigned to that provisional ball selected
Ball Lie Object
Field Name
Type
Description
x
decimal
X co-ordinate of the ball
y
decimal
Y co-ordinate of the ball
z
decimal
Z co-ordinate of the ball
shotDistance
int
How far the shot went for that stroke
distanceToPin
int
How far the ball is from the pin
surfaceType
string
What type of grass/area is the ball in. Possible values;
Undefined, Unsure, Fairway, Green, Fringe, Rough, IntermediateRough, WaterHazard, LateralWaterHazard, FairwayBunker, GreensideBunker, Tee, OutOfBounds, OtherFairway, Trees, Desert, Other
obstructions
boolean
true if the team has an obstruction next to the ball that makes the ball hard to hit
blindshot
boolean
true if the team cannot see the pin from where they are taking the shot
Sample Event Packet
Last updated