 |
|
Input parameters of the GetMatches API. More...
Public Attributes | |
| $Credentials | |
| $DivisionId | |
| $Club | |
| $Team | |
| $DivisionCategory | |
| $Season | |
| $WeekName | |
| $Level | |
| $ShowDivisionName | |
| $YearDateFrom | |
| $YearDateTo | |
| $WithDetails | |
| $MatchId | |
| $MatchUniqueId | |
Input parameters of the GetMatches API.
| GetMatchesRequest::$Club |
The club where the return team(s) play
This parameter is optional. If this parameter is not given, DivisionId must be given (and vice versa)
If set, this parameter contains the unique identifier of the club where the team(s) returned by GetMatches belongs to. Example : VLB-225 for VTTL club of Hurricane TTW.
type: string
| GetMatchesRequest::$Credentials |
| GetMatchesRequest::$DivisionCategory |
The division category the matches were played in.
This parameter is optional. If not given all matches of all categories are returned. A division category is a logical group of divisions, usually by player type (men only, veterans, youth teams)
type: int
| GetMatchesRequest::$DivisionId |
The internal identifier of the requested division
This parameter is optional. If this parameter is not given, Club must be given (and vice versa)
type: int
| GetMatchesRequest::$Level |
The level the matches were played in.
This parameter is optional. If not given all matches of all levels are returned. A level is a logical group of divisions (eg per provinces or regions).
type: int
| GetMatchesRequest::$MatchId |
The match identifier to consider.
This code is given by the championship organisator. Example: VLB/01/002 or LAND/12/121. This identifier is unique among all matches of a given season but may not be unique among all the matches.
This parameter is optional.
type: string
| GetMatchesRequest::$MatchUniqueId |
The unique identified to consider.
This code is given by the TabT application. It is a positive integer that is unique among all matches.
This parameter is optional.
type: int
| GetMatchesRequest::$Season |
The season when the matches have been played.
This parameter is optional, default is the current season (see GetSeasons). Attention: if no season is given in conjuction with other parameters, the returned list of matches may be empty because only matches of the current season will be considered
type: int
| GetMatchesRequest::$ShowDivisionName |
Indicates if the response should include the name of the division.
This parameter is optional. If not given, the name of the division is not returned. Possible values are:
Afdeling 2A - Prov. Vl.-B/Br. - Heren) 2A) type: ShowDivisionNameType
| GetMatchesRequest::$Team |
The team letter to be returned (within a given club)
This parameter is optional. If this parameter is set then Club parameter must also have been given.
type: string
| GetMatchesRequest::$WeekName |
The name of week when the matches have been played.
This parameter is optional. If not given all matches of all weeks are returned.
type: string
| GetMatchesRequest::$WithDetails |
Returns detailed results for all returned matches. See TeamMatchEntry
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
| GetMatchesRequest::$YearDateFrom |
This paramter can be used to filter returned matches based on their date. Only matches played after this date will be returned.
Format of the date must be YYYY-MM-DD.
This parameter is optional. By default, no filter will be applied on the match date.
type: dateTime
| GetMatchesRequest::$YearDateTo |
This paramter can be used to filter returned matches based on their date. Only matches played before this date will be returned.
Format of the date must be YYYY-MM-DD.
This parameter is optional. By default, no filter will be applied on the match date.
type: dateTime