Round: Started / Finished / Official

Round Started

Indicates a team has started to play a the particular round.

Round Started Object

Field Name	Type	Description
matchType	string	The type of match in which the event is being played; Strokeplay is the standard response currently
eventElementType	string	The type of event Full list of values include: TglHammerThrown RefereeCalled HoleScoreUpdate Correction ModeChange Penalty RoundStatusUpdate BallDrop ProvisionalBallSelected HitBall AddressingBall ApproximateLie DetailedLie BallHoled
state	object	The type of status update, in this case always Round Started.
seqNum	integer	The sequence number of the packet. Always starts at 1, increments in 1
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
players	array	See object docs
holeNo	integer	The hole No 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
roundNo	integer	The current round number

Players Object

Field Name	Type	Description
displayName	string	The display name of the player
country	string	3-character ICO country code of the player*
isAmateur	boolean	true if the player is an amateur
lastName	string	the last name of the player
firstName	string	the first name of the player
gender	string	gender of the player
playerId	integer	The unique player ID of that player

Sample Event Packet:

{
  "courseId": "392",
  "eventElementType": "RoundStatusUpdate",
  "groupId": 1211393,
  "groupNo": 45,
  "holeNo": 10,
  "holeOrder": 1,
  "matchType": "Strokeplay",
  "players": [
    {
      "country": "FRA",
      "displayName": "Benjamin Hebert",
      "firstName": "Benjamin",
      "gender": "male",
      "id": 104,
      "isAmateur": false,
      "lastName": "Hebert"
    }
  ],
  "roundNo": 1,
  "seqNum": 1,
  "state": "RoundStarted",
  "teamNo": 84,
  "timestamp": "2025-02-20T12:09:59.000Z",
  "timestampReceived": "2025-02-20T12:09:59.324Z"
}

Round Finished

Indicates a team has finished playing that particular round. NOT the last packet in the Round Details feed, see RoundOfficial below.

Round 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 No of the player who did the event
teamNon	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 Full list of values include: TglHammerThrown RefereeCalled HoleScoreUpdate Correction ModeChange Penalty RoundStatusUpdate BallDrop ProvisionalBallSelected HitBall AddressingBall ApproximateLie DetailedLie BallHoled
state	object	The type of status update, in this case always Round Finished.
roundNo	integer	The current round number

Sample Event Packet:

{
  "courseId": "392",
  "eventElementType": "RoundStatusUpdate",
  "groupId": 1211369,
  "groupNo": 17,
  "holeNo": 9,
  "holeOrder": 18,
  "roundNo": 1,
  "seqNum": 92,
  "state": "RoundFinished",
  "teamNo": 10,
  "timestamp": "2025-02-20T09:39:07.000Z",
  "timestampReceived": "2025-02-20T09:39:07.906Z"
}

Round Official

Indicates a team has finished playing that particular round and that the score for that round is now official and will not change – Upon receiving this packet you should disconnect from the web socket for this team’s round – no more data will be sent through after this packet.

Round 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 No of the player who did the event
teamNon	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 Full list of values include: TglHammerThrown RefereeCalled HoleScoreUpdate Correction ModeChange Penalty RoundStatusUpdate BallDrop ProvisionalBallSelected HitBall AddressingBall ApproximateLie DetailedLie BallHoled
state	object	The type of status update, in this case always Round Official.

Sample Event Packet:

{
  "courseId": "392",
  "eventElementType": "RoundStatusUpdate",
  "groupId": 1211369,
  "groupNo": 17,
  "holeNo": 9,
  "holeOrder": 18,
  "roundNo": 1,
  "seqNum": 93,
  "state": "RoundOfficial",
  "teamNo": 10,
  "timestamp": "2025-02-20T09:39:07.000Z"
}

Doc navigation

← HeartbeatsHole: Started / Finished →