hole started finished

Hole Started

Indicates a team has started to play a particular hole.

Hole Started Object

Field Name

Type

Description

seqNum

int

The sequence number of the packet. Always starts at 1, increments in 1

groupId

int

[Optional] The group ID of the player who did the event

teamId

int

The team ID of the player who did the event

playerId

int

The player ID of the player who did the event

hole

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

matchType

string

The type of match in which the event is being played; Strokeplay is the standard response currently

timestamp

date

The timestamp of the event, in UTC

eventElementType

string

The type of event

matchStatus

object

The type of status update, in this case always Hole Started.

Sample Event Packet:

{
	"groupNo": 1,
	"teamId": 489,
	"hole": 1,
	"PlayerId": 313,
	"holeOrder": 1,
	"courseId": 123,
	"timestamp": "2018-07-31T07:51:44.642Z",
	"eventElementType": "RoundStatusUpdate",
	"seqNum": 2,
	"matchType": "Strokeplay",
	"state": "HoleStarted"
}

Hole Finished

Indicates a team has finished playing a particular hole.

Hole Finished Object

Field Name

Type

Description

seqNum

int

The sequence number of the packet. Always starts at 1, increments in 1

groupId

int

[Optional] The group ID of the player who did the event

teamId

int

The team ID of the player who did the event

playerId

int

The player ID of the player who did the event

hole

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

matchType

string

The type of match in which the event is being played; Strokeplay is the standard response currently

timestamp

date

The timestamp of the event, in UTC

eventElementType

string

The type of event

state

string

The type of status update, in this case always Hole Finished

finishReason

string

“finishReason” is a string value that explains why a Hole was finished, can be BallHoled, Disqualified, Withdrawn.

Sample Event Packet:

{
	"groupNo": 1,
	"teamId": 489,
	"hole": 1,
	"PlayerId": 313,
	"holeOrder": 1,
	"courseId": 123,
	"timestamp": "2018-07-31T07:51:44.642Z",
	"eventElementType": "RoundStatusUpdate",
	"seqNum": 15,
	"matchType": "Strokeplay",
	"state": "HoleFinished",
	"finishReason": "BallHoled",
}

Last updated