Corrections

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	int	The sequence number of the packet. Always starts at 1, increments in 1
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

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	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

Surface Types:

surfaceTypeCode	surfaceType
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

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	int	The hole in which the event took place that is being corrected
eventElementType	string	The type of event that is being corrected
strokeNo	int	The stroke associated with the event that is being corrected
playerId	int	The player ID of the player who did the event that is being corrected

Sample Event Packet

In this example an Approximate Lie packet has been corrected – The distance to pin and shot distance are the details which have been updated.

{
    "timestamp": "2022-01-13T22:27:33.763Z",
    "courseId": "83",
    "corrections": {
        "ballLie": {
            "coordinates": {
                "x": 7919.554,
                "y": 11861.886,
                "z": 36.289
            },
            "surfaceTypeCode": "OFW",
            "distanceToPin": 14.808,
            "shotDistance": 120.726,
            "blindShot": false,
            "surfaceType": "Fairway",
            "obstructions": false
        },
        "strokeNo": 2,
        "provisionalIndex": 0
    },
    "eventCorrectedIdentifier": {
        "holeNo": 5,
        "playerId": 3403,
        "strokeNo": 2,
        "eventElementType": "ApproximateLie"
    },
    "eventElementType": "Correction",
    "seqNum": 430,
    "timestampReceived": "2022-01-13T22:27:37.084Z"
}

Doc navigation

← Provision Ball SelectedHole Score Update →