Public Attributes | List of all members
TournamentRegister Struct Reference

Input parameters of the TournamentRegister API. More...

Public Attributes

 $Credentials
 
 $TournamentUniqueIndex
 
 $SerieUniqueIndex
 
 $PlayerUniqueIndex
 
 $Unregister
 
 $NotifyPlayer
 

Detailed Description

Input parameters of the TournamentRegister API.

See also
TournamentRegister

Member Data Documentation

◆ $Credentials

TournamentRegister::$Credentials

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

type: CredentialsType

◆ $NotifyPlayer

TournamentRegister::$NotifyPlayer

If set to "no", concerned player will not receive a mail notification if their registration is changed.

This parameter is optional. If not given, player(s) will be notified of any change in their tournament registration.

type: boolean

◆ $PlayerUniqueIndex

TournamentRegister::$PlayerUniqueIndex

The unique index of the player to (un)register to/from the serie.

Two entries can be given (in case of double serie)

type: int

◆ $SerieUniqueIndex

TournamentRegister::$SerieUniqueIndex

The unique index of the serie to which the player(s) want(s) to (un)register.

type: int

◆ $TournamentUniqueIndex

TournamentRegister::$TournamentUniqueIndex

The unique index of the tournament to which the player(s) want(s) to (un)register.

This parameter is optional. If not given, Tournament unique index of the serie will be taken.

type: int

◆ $Unregister

TournamentRegister::$Unregister

If set to "true", player(s) will be unregistered from the serie.

This parameter is optional. If not given, player(s) will be registered for the requested serie.

type: boolean


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