ISV API Clubhouse Golf Ireland

https://isvapi.clubhouse.golfireland.ie/
Admin
ISV API is a REST API service for Clubhouse Golf Ireland that provides access to golf course and...
Tokens:37,080
Snippets:167
Trust Score:8.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /api/{countryCode}/v1/courses/{courseUID}

Source: https://isvapi.clubhouse.golfireland.ie/index

Retrieves a specific course.

```APIDOC
## GET /api/{countryCode}/v1/courses/{courseUID}

### Description
Retrieves a specific course.

### Method
GET

### Endpoint
/api/{countryCode}/v1/courses/{courseUID}

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.
- **courseUID** (string) - Required - The unique identifier of the course.

### Response
#### Success Response (200)
- **course** (object) - The course object.

#### Response Example
{
  "course": {
    "courseUID": "course1",
    "name": "Example Course"
  }
}

```

--------------------------------

### GET /api/{countryCode}/v1/courses/pcc

Source: https://isvapi.clubhouse.golfireland.ie/index

Retrieves the playing conditions calculation of the user's courses after the given sinceUTC date.

```APIDOC
## GET /api/{countryCode}/v1/courses/pcc

### Description
Retrieves the playing conditions calculation of the user's courses after the given sinceUTC date.

### Method
GET

### Endpoint
/api/{countryCode}/v1/courses/pcc

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

#### Query Parameters
- **sinceUTC** (datetime) - Optional - The date to retrieve PCC from.

### Response
#### Success Response (200)
- **pccData** (object) - The PCC data.

#### Response Example
{
  "pccData": {
    "courseUID": "course1",
    "pcc": 1.0
  }
}

```

--------------------------------

### GET /api/{countryCode}/v1/webhooks/{webhookUID}

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves an existing webhook by its unique identifier.

```APIDOC
## GET /api/{countryCode}/v1/webhooks/{webhookUID}

### Description
Retrieves an existing webhook using its unique identifier.

### Method
GET

### Endpoint
/api/{countryCode}/v1/webhooks/{webhookUID}

### Parameters
#### Path Parameters
- **webhookUID** (string) - Required - The unique identifier (UUID) of the webhook.
- **countryCode** (string) - Required - The country code associated with the webhook.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **(Schema not fully provided in input)** - Details of the requested webhook.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /api/{countryCode}/v1/courses/all

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns all courses country-wide. Note: This endpoint is not permitted in most National Associations at the present time. Marker information is not included, but can be obtained for each course by calling the courses/{uid} endpoint.

```APIDOC
## GET /api/{countryCode}/v1/courses/all

### Description
Returns all courses country-wide. Note: This endpoint is not permitted in most National Associations at the present time. Marker information is not included, but can be obtained for each course by calling the courses/{uid} endpoint.

### Method
GET

### Endpoint
/api/{countryCode}/v1/courses/all

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

### Response
#### Success Response (200)
- **courses** (array) - An array of course objects.

#### Response Example
{
  "courses": [
    {
      "courseUID": "course1",
      "name": "Example Course"
    }
  ]
}

```

--------------------------------

### Tournament Information

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieve details about tournaments, including their start and end dates, description, and the associated club.

```APIDOC
## GET /api/tournaments/{tournamentUID}

### Description
Retrieves detailed information about a specific tournament.

### Method
GET

### Endpoint
/api/tournaments/{tournamentUID}

### Parameters
#### Path Parameters
- **tournamentUID** (string) - Required - The unique identifier of the tournament.

### Response
#### Success Response (200 OK)
- **startDateUTC** (string) - The start date of the tournament in UTC.
- **endDateUTC** (string) - The end date of the tournament in UTC.
- **description** (string) - A description of the tournament.
- **clubUID** (string) - The unique identifier of the club hosting the tournament.

#### Response Example
```json
{
  "startDateUTC": "2023-11-01T08:00:00Z",
  "endDateUTC": "2023-11-05T17:00:00Z",
  "description": "Annual Club Championship",
  "clubUID": "c1d2e3f4-a5b6-7890-1234-567890abcdef"
}
```
```

--------------------------------

### GET /api/{countryCode}/v1/scorebatches/{scoreBatchUID}

Source: https://isvapi.clubhouse.golfireland.ie/index

Get a specific score batch.

```APIDOC
## GET /api/{countryCode}/v1/scorebatches/{scoreBatchUID}

### Description
Get a
```

--------------------------------

### GET /api/{countryCode}/v1/club/members

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns a list of members for the home club.

```APIDOC
## GET /api/{countryCode}/v1/club/members

### Description
Returns a list of members for the home club.

### Method
GET

### Endpoint
/api/{countryCode}/v1/club/members

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

### Response
#### Success Response (200)
- **members** (array) - An array of member objects.

#### Response Example
{
  "members": [
    {
      "memberUID": "member1",
      "firstName": "John",
      "lastName": "Doe"
    },
    {
      "memberUID": "member2",
      "firstName": "Jane",
      "lastName": "Smith"
    }
  ]
}

```

--------------------------------

### GET /api/{countryCode}/v1/clubs/{clubUID}

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns a single club.

```APIDOC
## GET /api/{countryCode}/v1/clubs/{clubUID}

### Description
Returns a single club.

### Method
GET

### Endpoint
/api/{countryCode}/v1/clubs/{clubUID}

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.
- **clubUID** (string) - Required - The unique identifier of the club.

### Response
#### Success Response (200)
- **club** (object) - The club object.

#### Response Example
{
  "club": {
    "clubUID": "club1",
    "name": "Example Club"
  }
}

```

--------------------------------

### GET /api/{countryCode}/v1/clubs/{clubUID}/courses

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns all current course and tee marker information for the specified club.

```APIDOC
## GET /api/{countryCode}/v1/clubs/{clubUID}/courses

### Description
Returns all current course and tee marker information for the specified club.

### Method
GET

### Endpoint
/api/{countryCode}/v1/clubs/{clubUID}/courses

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.
- **clubUID** (string) - Required - The unique identifier of the club.

### Response
#### Success Response (200)
- **courses** (array) - An array of course objects.

#### Response Example
{
  "courses": [
    {
      "courseUID": "course1",
      "name": "Example Course"
    }
  ]
}

```

--------------------------------

### GET /api/{countryCode}/v1/tournaments

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves a list of tournaments, optionally including past tournaments.

```APIDOC
## GET /api/{countryCode}/v1/tournaments

### Description
Retrieves a list of tournaments, optionally including past tournaments.

### Method
GET

### Endpoint
/api/{countryCode}/v1/tournaments

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code for the API request.

#### Query Parameters
- **includePastTournaments** (boolean) - Optional - Defaults to false. If true, includes past tournaments in the response.

### Request Example
```json
{
  "query": {
    "includePastTournaments": true
  }
}
```

### Response
#### Success Response (200)
- **items** (array) - An array of FullTournament objects.

#### Response Example
```json
{
  "items": [
    {
      "uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "name": "Sample Tournament",
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-01-05T00:00:00Z",
      "isPast": false
    }
  ]
}
```
```

--------------------------------

### GET /api/{countryCode}/v1/club/visitors/{memberUID}

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves visitor details for a specified MemberUID. Optionally filters by a timestamp to get handicap index as of a specific date.

```APIDOC
## GET /api/{countryCode}/v1/club/visitors/{memberUID}

### Description
Returns visitor details for the specified MemberUID. If a timestamp is specified for `asBeforeUTC`, the handicap returned for the visitor will be at the start of the day containing that timestamp. Otherwise, the visitor's handicap index for the current day is returned. Note that if a score was returned TODAY for this visitor, it will not be yet included in the visitor's handicap index.

### Method
GET

### Endpoint
/api/{countryCode}/v1/club/visitors/{memberUID}

### Parameters
#### Path Parameters
- **memberUID** (string) - Required - The unique identifier of the member.
- **countryCode** (string) - Required - The country code for the API request.

#### Query Parameters
- **asBeforeUTC** (string) - Optional - Date-time string. Filters the handicap index to the start of the day specified.

### Request Example
```json
{
  "memberUID": "123e4567-e89b-12d3-a456-426614174000",
  "countryCode": "IE",
  "query": {
    "asBeforeUTC": "2024-06-01T12:00:00Z"
  }
}
```

### Response
#### Success Response (200)
- **memberUID** (string) - The unique identifier of the member.
- **handicapIndex** (number) - The visitor's handicap index.
- **lastScoreDateUTC** (string) - The date and time of the visitor's last score.

#### Response Example
```json
{
  "memberUID": "123e4567-e89b-12d3-a456-426614174000",
  "handicapIndex": 15.4,
  "lastScoreDateUTC": "2024-05-30T09:30:00Z"
}
```
```

--------------------------------

### GET /api/{countryCode}/v1/courses/{courseUID}

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves details for a specific course using its unique identifier and country code. Requires Bearer token authentication.

```APIDOC
## GET /api/{countryCode}/v1/courses/{courseUID}

### Description
Retrieves a specific course by its unique identifier and country code.

### Method
GET

### Endpoint
/api/{countryCode}/v1/courses/{courseUID}

### Parameters
#### Path Parameters
- **courseUID** (string) - Required - The unique identifier (UUID) of the course.
- **countryCode** (string) - Required - The country code for the course.

### Request Example
(No request body for this GET request)

### Response
#### Success Response (200)
- **FullCourse** (object) - Detailed information about the course.

#### Response Example
(Response structure depends on the `FullCourse` schema)
```

--------------------------------

### GET /api/{countryCode}/v1/courses

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns all courses for the user's club and their current marker information (at the time of retrieval).

```APIDOC
## GET /api/{countryCode}/v1/courses

### Description
Returns all courses for the user's club and their current marker information (at the time of retrieval).

### Method
GET

### Endpoint
/api/{countryCode}/v1/courses

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

### Response
#### Success Response (200)
- **courses** (array) - An array of course objects.

#### Response Example
{
  "courses": [
    {
      "courseUID": "course1",
      "name": "Example Course"
    }
  ]
}

```

--------------------------------

### GET /api/{countryCode}/v1/clubs/user

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns the club controlled by the authenticated user.

```APIDOC
## GET /api/{countryCode}/v1/clubs/user

### Description
Returns the club controlled by the authenticated user.

### Method
GET

### Endpoint
/api/{countryCode}/v1/clubs/user

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

### Response
#### Success Response (200)
- **club** (object) - The club object.

#### Response Example
{
  "club": {
    "clubUID": "club1",
    "name": "Example Club"
  }
}

```

--------------------------------

### GET /api/{countryCode}/v1/tournaments

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves a list of all tournaments associated with the authenticated user for a given country.

```APIDOC
## GET /api/{countryCode}/v1/tournaments

### Description
Retrieves a list of all tournaments associated with the authenticated user for a given country.

### Method
GET

### Endpoint
`/api/{countryCode}/v1/tournaments`

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code for which to retrieve tournaments.

### Response
#### Success Response (200)
- **PagedResponse[BriefMemberScore]** (object) - Reference to the schema defining a paged response of brief member scores. (Note: The provided text suggests this schema, but the summary implies tournament data). 

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### GET /api/{countryCode}/v1/club/members/{memberUID}

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns full member details the club holds for the specified member UID.

```APIDOC
## GET /api/{countryCode}/v1/club/members/{memberUID}

### Description
Returns full member details the club holds for the specified member UID.

### Method
GET

### Endpoint
/api/{countryCode}/v1/club/members/{memberUID}

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.
- **memberUID** (string) - Required - The unique identifier of the member.

### Response
#### Success Response (200)
- **member** (object) - The member details.

#### Response Example
{
  "member": {
    "memberUID": "memberUID",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  }
}

```

--------------------------------

### GET /api/{countryCode}/v1/club/members/{memberUID}/handicap

Source: https://isvapi.clubhouse.golfireland.ie/index

Retrieves a Handicap Index for the specified member. If a timestamp is specified for asBeforeUTC, the handicap returned for the member will be what it was before that moment of time. Otherwise, the member's current Handicap Index is returned.

```APIDOC
## GET /api/{countryCode}/v1/club/members/{memberUID}/handicap

### Description
Retrieves a Handicap Index for the specified member. If a timestamp is specified for asBeforeUTC, the handicap returned for the member will be what it was before that moment of time. Otherwise, the member's current Handicap Index is returned.

### Method
GET

### Endpoint
/api/{countryCode}/v1/club/members/{memberUID}/handicap

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.
- **memberUID** (string) - Required - The unique identifier of the member.

#### Query Parameters
- **asBeforeUTC** (datetime) - Optional - Timestamp to retrieve handicap as of.

### Response
#### Success Response (200)
- **handicapIndex** (number) - The member's handicap index.

#### Response Example
{
  "handicapIndex": 12.5
}

```

--------------------------------

### GET /api/{countryCode}/v1/tournaments/{tournamentUID}

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves detailed information about a specific tournament using its unique identifier and country code.

```APIDOC
## GET /api/{countryCode}/v1/tournaments/{tournamentUID}

### Description
Retrieves detailed information about a specific tournament using its unique identifier and country code.

### Method
GET

### Endpoint
`/api/{countryCode}/v1/tournaments/{tournamentUID}`

### Parameters
#### Path Parameters
- **tournamentUID** (string) - Required - The unique identifier for the tournament.
- **countryCode** (string) - Required - The country code for the tournament.

### Response
#### Success Response (200)
- **BriefMemberScore** (object) - Reference to the schema defining a paged response of brief member scores.
- **FullTournament** (object) - Reference to the schema defining full tournament details.

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### GET /api/{countryCode}/v1/club/members/{memberUID}/handicap/scores

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns a handicap record consisting of a player's the top 20 scores with adjustments and their current full handicap (at start-of-day).

```APIDOC
## GET /api/{countryCode}/v1/club/members/{memberUID}/handicap/scores

### Description
Returns a handicap record consisting of a player's the top 20 scores with adjustments and their current full handicap (at start-of-day).

### Method
GET

### Endpoint
/api/{countryCode}/v1/club/members/{memberUID}/handicap/scores

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.
- **memberUID** (string) - Required - The unique identifier of the member.

### Response
#### Success Response (200)
- **handicapRecord** (object) - The handicap record.

#### Response Example
{
  "handicapRecord": {
    "handicapIndex": 12.5,
    "scores": [
      {
        "score": 75,
        "date": "2024-01-01"
      }
    ]
  }
}

```

--------------------------------

### GET /api/{countryCode}/v1/fourball-scores/{score4BBBUID}

Source: https://isvapi.clubhouse.golfireland.ie/index

Get a four-ball score.

```APIDOC
## GET /api/{countryCode}/v1/fourball-scores/{score4BBBUID}

### Description
Get a four-ball score.

### Method
GET

### Endpoint
/api/{countryCode}/v1/fourball-scores/{score4BBBUID}

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.
- **score4BBBUID** (string) - Required - The unique identifier of the four-ball score.

### Response
#### Success Response (200)
- **score** (object) - The four-ball score details.

#### Response Example
{
  "score": {
    "score4BBBUID": "score1",
    "players": ["member1", "member2", "member3", "member4"],
    "score": 72
  }
}

```

--------------------------------

### Definitions

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

This section details the various data structures used within the API, such as BriefMarker, BriefMember, and BriefMemberScore.

```APIDOC
## Definitions

### BriefMarker

- **bogeyRating** (integer) - A measurement of the difficulty of a course for bogey golfers relative to the course rating.
- **courseRating** (number) - The playing difficulty of the course for a scratch golfer.
- **region** (string) - The region in which the course is located
- **isNineHole** (boolean) - Indicates whether this is a 9 hole marker.
- **markerUID** (string) - The unique identifier for the marker.

### BriefMember

- **uid** (string) - Uniquely identifies this person within the API.
- **centralMemberCode** (string) - A number that identifies this person within the union.
- **gender** (EnumsGender) - The gender of the member.
- **handicap** (BriefHandicap) - The member's current handicap information.
- **dateOfBirth** (string) - The date of birth of the person.

### BriefMemberScore

- **scoreUID** (string) - A unique value that identifies this score in the API.
- **memberUID** (string) - Identifies the member who played this round.
- **playedAtUTC** (string) - The date and (approximate) time that the round was played, in UTC.
- **playedAtLocal** (string) - The date and (approximate) time that the round was played, in the local time of the course.
- **postedAtUTC** (string) - The date and time this score with posted to the API, in UTC.
- **changeDateUTC** (string) - The date this score was last updated in the API.
- **marker** (BriefMarker) - Information about the marker for this score.
- **grossScore** (integer) - The gross score of the round of golf. Null if not available.
- **adjustedGrossScore** (integer) - The adjusted gross score of the round.
- **handicapIndex** (number) - The player's handicap index at the point in time this round of golf commenced.
- **scoreDifferentialPrePCC** (number) - The pre-PCC score differential value for this score.
- **courseHandicap** (integer) - The player's course handicap
- **isCompetitionScore** (boolean) - Indicates this score was played during a competition. Null if this is not known.
- **isMatchPlayScore** (boolean) - Indicates this score was played during Match play rather than Stroke play. Null if not known.
- **holesPlayed** (integer) - The number of holes the player attempted during this round. Null if not known.
- **isDeleted** (boolean) - Indicates whether this score has been deleted and is no longer valid for handicapping.

### BriefMembership

- **memberUID** (string) - The unique identifier for the member associated with this membership.
```

--------------------------------

### Token Generation and Authentication

Source: https://isvapi.clubhouse.golfireland.ie/v1documentation

This section explains how to generate a JWT token with specific claims and use it to obtain an access token from the API.

```APIDOC
## JWT Token Generation and Authentication

### Description
Generate a JWT token with the required details and POST it to the `/api/ie/v1/account/token` endpoint to obtain an access token.

### Method
POST

### Endpoint
`http://isvapi.clubhouse.golfireland.ie/api/ie/v1/account/token`

### Parameters
#### Request Body
- **clientToken** (string) - Required - The generated JWT token.

### Request Example
```json
{
  "clientToken": "your-jwt-token"
}
```

### Response
#### Success Response (200)
- **accessToken** (string) - The access token for API authentication.
- **refreshToken** (string) - The refresh token to obtain a new access token.
- **expiresAtUTC** (string) - The expiration date and time of the access token in UTC.

#### Response Example
```json
{
  "accessToken": "string",
  "refreshToken": "string",
  "expiresAtUTC": "2020-02-02T20:50:52.499Z"
}
```
```

--------------------------------

### Webhook Data Structures

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

This section details the data structures used for configuring and representing webhooks.

```APIDOC
## Webhook Data Structures

### FullWebhook

**Description:** Represents a URL to be called when a specific API event occurs.

**Required:**
- event
- url

**Properties:**
- **webhookUID** (string, format: uuid) - Uniquely identified this webhook in the API.
- **event** (WebhookEvent) - The type of event that triggers the webhook.
- **url** (string, pattern: "^(https:\/\/)?([\da-z\.-]+\.[a-z\.]{2,6}|[\d\.]+)([\/:?=&#]{1}[\da-z\.-]+)*[\/\?]?$") - An HTTPS url. The API will POST event information to this URL when the Event is triggered.
```

--------------------------------

### GET /api/{countryCode}/v1/clubs

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns all clubs with the specified countrycode.

```APIDOC
## GET /api/{countryCode}/v1/clubs

### Description
Returns all clubs with the specified countrycode.

### Method
GET

### Endpoint
/api/{countryCode}/v1/clubs

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

### Response
#### Success Response (200)
- **clubs** (array) - An array of club objects.

#### Response Example
{
  "clubs": [
    {
      "clubUID": "club1",
      "name": "Example Club"
    }
  ]
}

```

--------------------------------

### Tournament and Course Data Structures

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Data structures related to tournaments and course information.

```APIDOC
## Tournament and Course Data Structures

### MarkerDataUpdated

**Description:** Represents an update of the handicapping information of a tee marker.

**Properties:**
- **course** (BriefCourse) - The course associated with the marker data update.
- **marker** (FullMarker) - The marker whose data has been updated.
```

--------------------------------

### FullTournament Object

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Represents an instance of a tournament held at a specific club.

```APIDOC
## FullTournament Object

### Description
An instance of a tournament at a specific club.

### Properties
- **tournamentUID** (string) - uuid - Uniquely identifies this tournament to the API
- **approvedByClub** (boolean) - Indicates this tournament instance has been approved by it's club
- **startDateUTC** (string) - date-time - The start date of the tournament in UTC. Scores for this tournament must have been played between the start date and end date.
- **endDateUTC** (string) - date-time - The end date of the tournament. After the end date, the tournament will no longer grant access to the course information of the club.
- **description** (string) - A description of the tournament, to be viewed by the club this tournament instance is for.
- **clubUID** (string) - uuid - Identifies the club hosting this tournament instance.

### Required Fields
- **clubUID**
- **description**
- **endDateUTC**
- **startDateUTC**
```

--------------------------------

### GET /api/{countryCode}/v1/categories

Source: https://isvapi.clubhouse.golfireland.ie/index

Returns all categories that can apply to members of the club.

```APIDOC
## GET /api/{countryCode}/v1/categories

### Description
Returns all categories that can apply to members of the club.

### Method
GET

### Endpoint
/api/{countryCode}/v1/categories

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

### Response
#### Success Response (200)
- **categories** (array) - An array of categories.

#### Response Example
{
  "categories": [
    {
      "id": "1",
      "name": "Category 1"
    },
    {
      "id": "2",
      "name": "Category 2"
    }
  ]
}

```

--------------------------------

### Playing Conditions Calculations

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Details the playing conditions calculations for a specific golf course over a period of days.

```APIDOC
## Playing Conditions Calculations

### Description
This structure provides information on the calculated playing conditions for a golf course, including daily calculations.

### Data Structures

#### BriefCoursePCC
The playing conditions calculations for a course for a period of days.

##### Properties

- **courseUID** (string) - The unique identifier of the course.
- **courseName** (string) - The name of the course.
- **playingConditionsCalculations** (array) - The playing conditions calculations for a range of days at the course. Each item in the array is of type BriefPlayingConditionsCalculation.
```

--------------------------------

### POST /api/{countryCode}/v1/tournaments

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Creates a new tournament. This operation will fail if the user already has the maximum number of live or future tournaments allowed.

```APIDOC
## POST /api/{countryCode}/v1/tournaments

### Description
Creates a new tournament. Fails if the user has more live or future tournaments than the max active tournament limit.

### Method
POST

### Endpoint
/api/{countryCode}/v1/tournaments

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code for the API request.

#### Request Body
- **data** (BriefTournament) - Required - The data for the new tournament.

### Request Example
```json
{
  "countryCode": "IE",
  "data": {
    "name": "New Tournament",
    "startDate": "2024-07-01T00:00:00Z",
    "endDate": "2024-07-05T00:00:00Z"
  }
}
```

### Response
#### Success Response (200 or 201)
- **uid** (string) - The unique identifier of the created tournament.

#### Response Example
```json
{
  "uid": "f0e1d2c3-b4a5-6789-0123-456789abcdef"
}
```
```

--------------------------------

### POST /api/{countryCode}/v1/webhooks

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Creates a Webhook to subscribe to specific API events. Event details are sent to the callback URL upon event occurrence. Webhook requests are validated using an X-DotGolf-Signature header.

```APIDOC
## POST /api/{countryCode}/v1/webhooks

### Description
Creates a Webhook to subscribe to specific API events. Details of the event and related data are sent to the callback URL when the event occurs. To validate webhook requests are from the API, the request to the callback URL includes an X-DotGolf-Signature header, which will contain the request JSON data hashed using the user's ISV key using the specified algorithm (currently only hmacsha256 is used).

### Method
POST

### Endpoint
/api/{countryCode}/v1/webhooks

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code for the webhook.

#### Request Body
- **data** (BriefWebhook) - Required - The webhook subscription details.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200 or 201)
- **CreatedObject** - Details of the created webhook.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **400** - Bad Request (returns ErrorResponse schema)
```

--------------------------------

### GET /api/{countryCode}/v1/scoreintents/{scoreIntentUID}

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves a specific intent to submit a score using its unique identifier.

```APIDOC
## GET /api/{countryCode}/v1/scoreintents/{scoreIntentUID}

### Description
Get a specific intent to submit a score.

### Method
GET

### Endpoint
/api/{countryCode}/v1/scoreintents/{scoreIntentUID}

### Parameters
#### Path Parameters
- **scoreIntentUID** (string) - Required - The unique identifier (UUID) of the score intent.
- **countryCode** (string) - Required - The country code for the score intent.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **schema** (FullScoreIntent) - The details of the requested score intent.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /api/{countryCode}/v1/addresses/labels

Source: https://isvapi.clubhouse.golfireland.ie/index

Retrieves the address labels for the National Association. This endpoint provides address-related information.

```APIDOC
## GET /api/{countryCode}/v1/addresses/labels

### Description
Retrieves the address labels for the National Association.

### Method
GET

### Endpoint
/api/{countryCode}/v1/addresses/labels

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The country code.

### Response
#### Success Response (200)
- **labels** (array) - An array of address labels.

#### Response Example
{
  "labels": [
    "Address Line 1",
    "Address Line 2",
    "City",
    "State",
    "Zip Code",
    "Country"
  ]
}

```

--------------------------------

### Member and Marker Definitions

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

This section details the data structures for representing members and course markers within the API.

```APIDOC
## Data Models

### Marker

Represents a set of tees at a specific course.

#### Properties

- **type** (string) - The type of marker.
- **markerHistoryUID** (uuid) - The unique identifier of the real-world marker for the API, as at the period of time between `EffectiveAtUTC` and `ExpiresBeforeUTC`.
- **effectiveAtUTC** (date-time) - Start date the changes are effective.
- **expiresBeforeUTC** (date-time) - End date the changes are effective.
- **deletedAtUTC** (date-time) - Captures the deleted date.
- **name** (string) - The name of the marker at the local course. Max length: 50.
- **gender** (string) - The gender of player the marker applies to for scoring and handicapping purposes. Max length: 1.
- **slope** (integer) - A measurement of the difficulty of a course for bogey golfers relative to the course rating.
- **courseRating** (number) - The playing difficulty of the course for a scratch golfer.
- **holes** (array) - A list of holes that form part of this marker. Items are of type `FullHole`.
- **transitionMarkerId** (integer) - A legacy identifier, used only when an ISV needs to map marker data from a previous system to DotGolf's API. MarkerUID should be used as the primary key value; TransitionMarkerId may not be populated for new markers created beyond go-live.
- **transitionLocalMarkerId** (integer) - A legacy identifier, used only when an ISV needs to map marker data from a previous system to DotGolf's API. MarkerUID should be used as the primary key value; TransitionLocalMarkerId may not be populated for new markers created beyond go-live.
- **teeMarkerNumber** (string) - The auto-generated number that uniquely identifies a marker within a course.

### FullMemberInsert

A new person who plays golf and is a member of a golf club, or a new membership for an existing person.

#### Properties

- **isHomeMember** (boolean) - A value indicating whether the person is a home member of the club submitting the person. Defaults to true.
- **linkMemberUID** (uuid) - The existing memberUID of the person. Links the person to their existing handicap and scoring history. Required when adding a new membership for an existing person.
- **duplicateCheckOverrideToken** (string) - When specified, the duplicate checks will be bypassed, allowing the client to create a member with similar details to an existing member.
- **dob** (date-time) - The date of birth of the person, or null if unknown.
- **firstName** (string) - The first name of the member. Max length: 50.
- **lastName** (string) - The last name of the member. Max length: 50.
- **email** (string) - An email address where the member may be contacted. This is used when verifying the identity of the member when registering for online services. Max length: 50.
- **gender** (EnumsGender) - The gender of the member.
- **initials** (string) - The initials of a person. Max length: 5.
- **address1** (string) - The person's physical address, line 1. Max length: 100.
- **address2** (string) - The person's physical address, line 2. Max length: 100.
- **address3** (string) - The person's physical address, line 3. Max length: 100.
```

--------------------------------

### GET /api/{countryCode}/v1/scores/{scoreUID}

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Retrieves the details of a specific score using its unique identifier and country code.

```APIDOC
## GET /api/{countryCode}/v1/scores/{scoreUID}

### Description
Retrieves a single score using its unique identifier and the country code.

### Method
GET

### Endpoint
`/api/{countryCode}/v1/scores/{scoreUID}`

### Parameters
#### Path Parameters
- **scoreUID** (string) - Required - The unique identifier of the score (UUID format).
- **countryCode** (string) - Required - The country code for the score.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **FullScore** (object) - The detailed score object.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### FullScoreIntent Object

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

Represents a player's intention to submit a score for handicap purposes at a specific club and date.

```APIDOC
## FullScoreIntent Object

### Description
Registers a player's intent to submit an acceptable score for handicap purposes at a given date and club.

### Properties
- **scoreIntentUID** (string) - uuid - Identifies the intent the player registered to submit a score at this date and club
- **scoreUID** (string) - uuid - Identifies the score that fulfilled this intent.
- **memberUID** (string) - uuid - Identifies the member this score intent is for.
- **clubUID** (string) - uuid - Identifies the club this member intends to play at.
- **playedAtUTC** (string) - date-time - The date and (approximate) time the member's round is intended to be played, in UTC.
- **isCompetitionPlay** (boolean) - Indicates whether the score is intended for competition play (as opposed to general play).
- **markerUID** (string) - uuid - Identifies the tee marker this member intends to play on.
- **scoreBatchUID** (string) - uuid - Identifies the score batch that the score intent is a part of.

### Required Fields
- **clubUID**
- **isCompetitionPlay**
- **memberUID**
- **playedAtUTC**
```

--------------------------------

### Member Creation

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

This endpoint allows for the creation of new members within the Golf Ireland system. It returns the unique identifier and relevant codes upon successful creation.

```APIDOC
## POST /api/members

### Description
Creates a new member in the Golf Ireland system.

### Method
POST

### Endpoint
/api/members

### Request Body
- **centralMemberCode** (string) - Required - Identifies this person within the union.
- **code** (object) - Required - Represents a change in membership status.
  - **type** (string) - Required - The type of membership change.
  - **effectiveDateUTC** (string) - Required - The date and time the membership change becomes effective, in UTC.

### Request Example
```json
{
  "centralMemberCode": "GOL12345",
  "code": {
    "type": "New",
    "effectiveDateUTC": "2023-10-27T10:00:00Z"
  }
}
```

### Response
#### Success Response (201 Created)
- **uid** (string) - The unique identifier for this member.
- **centralMemberCode** (string) - Identifies this person within the union.
- **code** (object) - Represents a change in membership status.
- **message** (string) - A human readable message about the successful POST.

#### Response Example
```json
{
  "uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "centralMemberCode": "GOL12345",
  "code": {
    "type": "New",
    "effectiveDateUTC": "2023-10-27T10:00:00Z"
  },
  "message": "Member created successfully."
}
```
```

--------------------------------

### Duplicate Member Check and Override

Source: https://isvapi.clubhouse.golfireland.ie/swagger/v1/swagger

This section details how to check for duplicate members and provides information on overriding duplicate checks during member creation.

```APIDOC
## POST /api/members/check-duplicates

### Description
Checks if a member already exists in the system based on provided details. Returns a list of potential duplicates if found.

### Method
POST

### Endpoint
/api/members/check-duplicates

### Parameters
#### Request Body
- **memberDetails** (object) - Required - Details of the member to check.
  - **firstName** (string) - Required - The first name of the member.
  - **lastName** (string) - Required - The last name of the member.
  - **dateOfBirth** (string) - Required - The date of birth of the member in YYYY-MM-DD format.
  - **gender** (string) - Required - The gender of the member ('Male' or 'Female').
  - **emailAddress** (string) - Optional - The email address of the member.
  - **phoneNumber** (string) - Optional - The phone number of the member.
  - **clubId** (string) - Optional - The ID of the club the member is associated with.

### Request Example
```json
{
  "memberDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1990-05-15",
    "gender": "Male",
    "emailAddress": "john.doe@example.com",
    "clubId": "club-123"
  }
}
```

### Response
#### Success Response (200)
- **duplicatesFound** (array) - A list of duplicate member records if any are found.
  - **memberUID** (string) - The unique identifier for the duplicate member.
  - **centralMemberCode** (string) - The central member code.
  - **isResigned** (boolean) - Indicates if the member has resigned.
  - **name** (string) - The full name of the member.
  - **clubName** (string) - The name of the club.
  - **handicapIndex** (number) - The member's handicap index.
  - **numberOfScores** (integer) - The number of scores in the member's handicap history.
  - **approximateDOB** (object) - The approximate date of birth.
  - **maskedEmailAddress** (string) - The masked email address.
- **duplicateCheckOverrideToken** (string) - A single-use token to override duplicate checking during member creation.

#### Response Example
```json
{
  "duplicatesFound": [
    {
      "memberUID": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "centralMemberCode": "987654",
      "isResigned": false,
      "name": "Doe, John",
      "clubName": "Example Golf Club",
      "handicapIndex": 15.5,
      "numberOfScores": 50,
      "approximateDOB": {
        "year": 1990,
        "month": 5
      },
      "maskedEmailAddress": "joh***@example.com"
    }
  ],
  "duplicateCheckOverrideToken": "some-override-token-123"
}
```

## POST /api/members

### Description
Creates a new member in the system. Can optionally use a duplicate check override token.

### Method
POST

### Endpoint
/api/members

### Parameters
#### Request Body
- **memberData** (object) - Required - The data for the new member.
  - **firstName** (string) - Required - The first name of the member.
  - **lastName** (string) - Required - The last name of the member.
  - **dateOfBirth** (string) - Required - The date of birth of the member in YYYY-MM-DD format.
  - **gender** (string) - Required - The gender of the member ('Male' or 'Female').
  - **emailAddress** (string) - Optional - The email address of the member.
  - **phoneNumber** (string) - Optional - The phone number of the member.
  - **clubId** (string) - Required - The ID of the club the member will be associated with.
- **duplicateCheckOverrideToken** (string) - Optional - A token obtained from a previous duplicate check to bypass duplicate verification.
```
Tokens:
Raw