This packet will be sent whenever a previous packet needs correcting. The original event still happened, at the time that it happened, BUT some of the details within that packet are being updated. Corrections can happen to the last event that happened, or to an event that happened X events ago (I.e it can happen in and out of sequence).
Current List of Events that can be Corrected:
Approximate Lie
Detailed Lie
Penalty
Ball Drop
Note – this list will change over time as we add new packets that can be corrected.
Correction Object
Field Name
Type
Description
seqNum
integer
The sequence number of the packet.
timestamp
date
The timestamp of the event, in UTC
eventElementType
string
The type of event, in this case Correction
timestampReceived
date
The server time of the moment that this packet has been processed
corrections
object
contains all information on the packet that is being corrected, even if certain information within the packet has not been corrected
courseId
string
The ID of the course where the event took place
eventCorrectedIdentifier
object
See object below
groupId
integer
The group ID of the player who did the event
roundNo
integer
The current round number
Corrections Object
Field Name
Type
Description
ballLie
object
See object below
provisionalIndex
integer
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…
strokeNo
integer
The stroke associated with the event that is being corrected
strokesAssessed
integer
The stroke assessed with the event that is being corrected
Ball Lie Object
Field Name
Type
Description
coordinates
object
See object below
shotDistance
integer
How far the shot went for that stroke. Data returned in meters.
distanceToPin
decimal
How far the ball is from the pin. Data returned in meters
surfaceType
string
Text string which describes the lie of the ball, can be inconsistent across different data collection systems / Tours. We recommend using the 3 letter codes.
See Surface Types table below.
surfaceTypeCode
string
3 letter enum code which describes the lie of the ball.
See Surface Types table below.
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
coordinates object:
Field
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
eventCorrectedIdentifier Object
This contains information unique to the event that is being corrected – use this information to reference the previous packet so you know what packet and what data to update.
Field Name
Type
Description
holeNo
integer
The hole in which the event took place that is being corrected
eventElementType
string
The type of event that is being corrected
strokeNo
integer
The stroke associated with the event that is being corrected
playerId
integer
The player ID of the player who did the event that is being corrected
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
teamNo
integer
The team number of the player who did the event
ODO
Dirt
For both PGA and DPWT
OFW
Fairway
For both PGA and DPWT
OST
Fairway Bunker
For both PGA and DPWT
OCO
Fringe
For both PGA and DPWT
OGR
Green
For both PGA and DPWT
OGS
Greenside Bunker
For both PGA and DPWT
OIR
Intermediate Rough
For both PGA and DPWT
ONA
Native Area
For both PGA and DPWT
OTH
Other
For both PGA and DPWT
ORO
Rough
For both PGA and DPWT
OTB
Tee Box
For both PGA and DPWT
OTO
Trees
For both PGA and DPWT
OUK
Unsure/Undefined
For both PGA and DPWT
OWA
WaterHazard/LateralWaterHazard
For both PGA and DPWT
OWB
Waste Bunker
For both PGA and DPWT
OBU
Bushes
DPWT only
ODS
Desert
DPWT only
OTF
OtherFairway
DPWT only
OOB
OutOfBounds
DPWT only
OCA
Cart Path
PGA only
OGR
Green
PGA only
OPT
Path
PGA only
ORK
Rock Outline
PGA only
OTB
Tee Box
For both PGA and DPWT
OWL
Wall
PGA only
Sample Event Packet
In this example an Detailed Lie packet has been corrected: