 |
|
Input parameters of the GetMembers API. More...
Public Attributes | |
| $Credentials | |
| $Club | |
| $Season | |
| $PlayerCategory | |
| $UniqueIndex | |
| $NameSearch | |
| $ExtendedInformation | |
| $RankingPointsInformation | |
| $WithResults | |
| $WithOpponentRankingEvaluation | |
Input parameters of the GetMembers API.
| GetMembersRequest::$Club |
The club the players are members of
This parameter contains the unique identifier of the club where the players(s) returned by GetMembers belongs to. Example : VLB-225 for VTTL club of Hurricane TTW.
This parameter is optional. But at least one search criteria has to be specified (club, unique index or name). If this parameter is specified, the response will not contain the player club.
type: string
| GetMembersRequest::$Credentials |
Defines credentials to connect to a TabT website type: CredentialsType
| GetMembersRequest::$ExtendedInformation |
Returns extended information about the returned members : status, gender, category and birthdate
If set to "true", valid credential has to be specified. Birthdate will only be given if given credential have administrive rights.
This parameter is optional. Default value is false.
type: boolean
| GetMembersRequest::$NameSearch |
The pattern the name of the request member must match. The wildcard character is the percent sign (%). Both last name and first name are searched. The search is not case sensitive.
This parameter is optional. But at least one search criteria has to be specified (club, unique index or name).
@ var string
| GetMembersRequest::$PlayerCategory |
The identifier of the player category to be considered
Usually 1 for men and 2 for women. This parameter is optional, default is the first player category which is usually the senior men.
type: int
| GetMembersRequest::$RankingPointsInformation |
Returns extended information about the member's new ranking evaluations.
If set to "true", valid credential has to be specified.
The number and level of details of the returned new ranking evaluations depend on the credential access rights and local configuration option "option allow_own_ranking_info".
This parameter is optional. Default value is false.
type: boolean
| GetMembersRequest::$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
| GetMembersRequest::$UniqueIndex |
The unique index of the requested member.
This parameter is optional. But at least one search criteria has to be specified (club, unique index or name).
type: int
| GetMembersRequest::$WithOpponentRankingEvaluation |
Returns detailed information about the new ranking evaluations of each member's opponent.
If set to "true", valid credential has to be specified. This option requires administrative or ranking rights.
This parameter is optional. Default value is false.
type: boolean
| GetMembersRequest::$WithResults |
Returns results of the member for the selected season.
This parameter is optional. Default value is false.
type: boolean