Hole Score Update

This packet will be sent whenever it is apparent that the score for a particular hole is incorrect, after scoring for that hole has finished. This can happen because of manual error by the scorer or for many other reasons.

This packet will indicate which hole has the issue, and what the score should have been for that hole.

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 HoleScoreUpdate

Full list of values include:

  • TglHammerThrown

  • RefereeCalled

  • HoleScoreUpdate

  • Correction

  • ModeChange

  • Penalty

  • RoundStatusUpdate

  • BallDrop

  • ProvisionalBallSelected

  • HitBall

  • AddressingBall

  • ApproximateLie

  • DetailedLie

  • BallHoled

corrections

object

contains all the parts of the packet that have been changed, and their new values, i.e the new score values in this instance

groupId

integer

the group ID of the player who did the event

roundNo

integer

The current round numer

eventCorrectedIdentifier

object

See object below

timestampReceived

date

The server time of the moment that this packet has been processed

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

hole

integer

The hole in which the event took place that is being corrected

playerId

integer

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.

{
    "seqNum": 293,
    "groupId": 1186622,
    "roundNo": 1,
    "timestamp": "2025-02-06T13:39:55.000Z",
    "corrections": {
        "score": {
            "currentHolePar": 4,
            "overallScoreToPar": "+5",
            "currentHoleStrokes": 4,
            "currentRoundScoreToPar": "+5"
        },
        "finishReason": "BallHoled",
        "scorePending": False
    },
    "eventElementType": "HoleScoreUpdate",
    "timestampReceived": "2025-02-06T13:39:55.777Z",
    "eventCorrectedIdentifier": {
        "holeNo": 14,
        "playerId": None
    }
}

Doc navigation

← CorrectionsUndos →

Last updated

Was this helpful?