Endpoints

Player Information Requirements

Player Information Requirements

When creating bookings through the GG365 Golf API, you must provide player information according to specific requirements. This information is necessary for golf courses to manage their bookings and ensure a smooth check-in experience.

Basic Player Information

The following basic information is required for all players:

Code
 
{
  "playerDetails": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": "+1 234 567 8900",
      "handicap": 15
    }
    // Additional players...
  ]
}

Required Fields for Lead Player

Field	Type	Description
firstName	string	Player's first name
lastName	string	Player's last name
email	string	Valid email address for booking confirmation
phone	string	Contact phone number with country code

Optional Fields

Field	Type	Description
handicap	integer	Player's golf handicap (if known)
country	string	Player's country of residence
languagePreference	string	Preferred language (ISO code)
membershipNumber	string	Golf club membership number (if applicable)

Player Requirements by Course Type

Different course types may have different player information requirements:

Resort Courses

Basic information is usually sufficient for resort courses.

Private Clubs

Private clubs often require additional information:

Code
 
{
  "playerDetails": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": "+1 234 567 8900",
      "handicap": 15,
      "homeClub": "Pinehurst Resort",
      "handicapVerification": "GHIN",
      "handicapId": "1234567"
    }
  ]
}

Additional fields for private clubs:

Field	Type	Description
homeClub	string	Player's home golf club
handicapVerification	string	Handicap verification system (GHIN, EGA, etc.)
handicapId	string	ID in the handicap verification system

International Courses

For international bookings, additional identity information may be required:

Code
 
{
  "playerDetails": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": "+1 234 567 8900",
      "nationality": "United States",
      "passportNumber": "123456789",
      "dateOfBirth": "1980-05-15"
    }
  ]
}

Additional fields for international courses:

Field	Type	Description
nationality	string	Player's nationality
passportNumber	string	Passport or ID number
dateOfBirth	string	Date of birth (YYYY-MM-DD)

Required Information by Region

Player information requirements can vary by region:

Europe

European courses typically require:

• Basic player information
• Handicap information for lead player
• Home club information

United States

US courses may require:

• Basic player information
• GHIN number for handicap verification
• Credit card for guarantee (handled securely through our payment system)

Middle East

Middle Eastern courses often require:

• Basic player information
• Passport details for international visitors
• Handicap certificate for premium courses

Data Privacy Considerations

When collecting and transmitting player information:

1. Collect only necessary information: Only request information that is actually required for the booking.
2. Inform players: Ensure your end-users know what information is being collected and why.
3. Secure transmission: All API requests containing personal data are encrypted via HTTPS.
4. Data retention: Player information is only retained as long as necessary for booking fulfillment.

Lead Player vs. Additional Players

The first player in the playerDetails array is considered the lead player and requires more complete information. For additional players, some fields may be optional depending on the course requirements.

Code
 
{
  "playerDetails": [
    {
      // Lead player - more complete information required
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": "+1 234 567 8900",
      "handicap": 15
    },
    {
      // Additional player - fewer fields required
      "firstName": "Jane",
      "lastName": "Doe",
      "handicap": 22
    }
  ]
}

Testing Player Information

Use our test courses to validate your player information collection:

• Course ID: test_course_minimal - Requires only minimal player information
• Course ID: test_course_standard - Requires standard player information
• Course ID: test_course_extensive - Requires extensive player information

These test courses can help you ensure your booking system is collecting all necessary player information for different course types.