Public Attributes | List of all members
GetTournamentsRequest Struct Reference

Input parameters of the GetTournaments API. More...

Public Attributes

 $Credentials
 
 $Season
 
 $TournamentUniqueIndex
 
 $WithResults
 
 $WithRegistrations
 

Detailed Description

Input parameters of the GetTournaments API.

See also
GetTournaments

Member Data Documentation

◆ $Credentials

GetTournamentsRequest::$Credentials

Defines credentials (username and password) to connect to a TabT website

type: CredentialsType

◆ $Season

GetTournamentsRequest::$Season

The season when the players were members of the requested club

This parameter is optional, default is the current season (see GetSeasons)

type: int

◆ $TournamentUniqueIndex

GetTournamentsRequest::$TournamentUniqueIndex

The unique index of the tournament to consider.

This parameter is optional. If not given, all tournaments of the considered season will be returned.

type: int

◆ $WithRegistrations

GetTournamentsRequest::$WithRegistrations

Returns registrations of the considered tournament.

This parameter is optional. Default value is false. If set to true, a tournament must be selected using $TournamentUniqueIndex.

type: boolean

◆ $WithResults

GetTournamentsRequest::$WithResults

Returns results of the considered tournament.

This parameter is optional. Default value is false. If set to true, a tournament must be selected using $TournamentUniqueIndex.

type: boolean


The documentation for this struct was generated from the following file: