 |
|
All TabT API functions. More...
Functions | |
| Test (stdClass $Request) | |
| Dummy test function to verify connectivity. More... | |
| GetSeasons (stdClass $Credentials) | |
| GetSeasons returns the list of seasons available in the TabT database. More... | |
| GetClubTeams (stdClass $Request) | |
| GetClubTeams returns a list with all the teams of a given club. More... | |
| GetDivisionRanking (stdClass $Request) | |
| Returns ranking of given division for a given week. More... | |
| GetMatches (stdClass $Request) | |
| Returns list of matches and, if they are available, the match results. More... | |
| GetMembers (stdClass $Request) | |
| Returns list of members according to a search criteria (club, index or name) More... | |
| Upload (stdClass $Request) | |
| Data upload using TabT-Upload format. More... | |
| GetClubs (stdClass $Request) | |
| Retrieve club list according to a given category. More... | |
| GetDivisions (stdClass $Request) | |
| Retrieve division list. More... | |
| GetTournaments (stdClass $Request) | |
| Retrieve tournament list. More... | |
| GetMatchSystems (stdClass $Request) | |
| Retrieve list (individual) match systems. More... | |
| TournamentRegister (stdClass $Request) | |
| Register player to existing tournaments. More... | |
| GetPlayerCategories (stdClass $Request) | |
| Retrieve list of player categories. More... | |
All TabT API functions.
TabT API types definition
| GetClubs | ( | stdClass | $Request | ) |
Retrieve club list according to a given category.
| $Request | GetClubsRequest |
| GetClubTeams | ( | stdClass | $Request | ) |
GetClubTeams returns a list with all the teams of a given club.
Each club has one or more teams playing in divisions. This function lists all the teams of a given club.
As an example, here is the returned data for VLB-295 (TTC Werchter) for season 2007-2008
389-7 | A | 389 | Afdeling 1 - Prov. Vl.-B/Br. - Heren | 1 390-7 | B | 390 | Afdeling 2A - Prov. Vl.-B/Br. - Heren | 1 397-2 | F | 397 | Afdeling 5B - Prov. Vl.-B/Br. - Heren | 1 396-9 | G | 396 | Afdeling 5A - Prov. Vl.-B/Br. - Heren | 1 401-2 | A | 401 | Afdeling 1 - Prov. Vl.-B/Br. - Veteranen | 3 403-2 | B | 403 | Afdeling 3 - Prov. Vl.-B/Br. - Veteranen | 3 | [in] | Request | Input parameters |
| GetDivisionRanking | ( | stdClass | $Request | ) |
Returns ranking of given division for a given week.
GetDivisionRanking returns the ranking of all teams playing with a division after a given week. If no week is given, the latest one will be selected automatically. The last week means the week that starts just before the current date.
With GetDivisionRanking, the webmaster can display on his/her website the ranking of the division where the teams of his/her club are playing.
Example for division #390 after 18 weeks of VTTL competition (season 2007-2008):
Afdeling 2A - Prov. Vl.-B/Br. - Heren
1 | T.T. Groot-Bijgaarden A | 18 | 13 | 2 | 3 | 196 | 92 | 641 | 378 | 29 2 | Werchter B | 18 | 11 | 4 | 3 | 158 | 130 | 525 | 400 | 25 3 | Hurricane TTW C | 17 | 10 | 2 | 5 | 167 | 104 | 610 | 440 | 25 4 | T.T.K. Vilvo F | 17 | 10 | 6 | 1 | 165 | 107 | 525 | 441 | 21 And here is the integration into the Werchter TTC website.
| GetDivisions | ( | stdClass | $Request | ) |
Retrieve division list.
| $Request | GetDivisionsRequest |
| GetMatches | ( | stdClass | $Request | ) |
Returns list of matches and, if they are available, the match results.
According to the parameters given in the GetMatchesRequest, GetMatches can be used to extract all matches played into a division, by a club or by a given team.
Example for team C of club VLB-225 (Hurricane TTW) for season 2006-2007
01/016 | 01 | 2006-09-15 | 19:45:00 | Hurricane C | Meerdaal D | 12-4 02/014 | 02 | 2006-09-22 | 19:45:00 | Essenbeek B | Hurricane C | 6-10 03/014 | 03 | 2006-09-29 | 19:45:00 | Hurricane C | V.M.S. B | 12-4 04/016 | 04 | 2006-10-20 | 19:45:00 | Hurricane C | Essenbeek D | 13-3 | $Request | GetMatchesRequest |
| GetMatchSystems | ( | stdClass | $Request | ) |
Retrieve list (individual) match systems.
| $Request | GetMatchSystemsRequest |
| GetMembers | ( | stdClass | $Request | ) |
Returns list of members according to a search criteria (club, index or name)
Each player belongs to a club. GetMembers can return the list of all players of a given club.
As an example, here is the member list of club VLB-225 (Hurricane TTW) for season 2007-2008:
1 | 505304 | 5 | MARC | DE DONCKER | B6 2 | 505292 | 5 | DAVID | WAEFELAER | B6 7 | 505384 | 8 | MICHEL | THAUVOYE | C2 8 | 505783 | 8 | PASCAL | TIMMERMANS | C2 17 | 505290 | 20 | GAËTAN | FRENOY | C6 18 | 505275 | 20 | CHRISTIAN | HOLTYZER | C6 You can also query information about a specific player. A player is identified by a unique index.
You can also search players based on their name (first name or last name).
If "WithResults" is set, player results will be returned along with player details.
| $Request | GetMembersRequest |
| GetPlayerCategories | ( | stdClass | $Request | ) |
Retrieve list of player categories.
Each player can be assigned to one or more player categories. According to his/herr player category, a player will be allowed to play some types of matches or competitions
| $Request | GetPlayerCategoriesRequest |
| GetSeasons | ( | stdClass | $Credentials | ) |
GetSeasons returns the list of seasons available in the TabT database.
Each season is identified by a unique positive number and a name. As an example, season ID of season 2007-2008 is 8.
Here is the returned data if 2008-2009 is the current season
1 | 2001-2002 | false 2 | 2002-2003 | false 7 | 2007-2008 | false 8 | 2008-2009 | true GetSeasons also returns the current season that is used in all other functions as the default season (when not specified explicitely)
| [in] | $Credentials | Optional identification of the caller |
| GetTournaments | ( | stdClass | $Request | ) |
Retrieve tournament list.
A tournament is a table tennis event where individual matches are played during one or several days.
Matches are played inside "series" that typically group players by category (age or ranking).
If a specific tournament is given, results of the selected tournament can be given.
| $Request | GetTournamentsRequest |
| Test | ( | stdClass | $Request | ) |
Dummy test function to verify connectivity.
Before trying anything else, you should try to call this function that will return (see TestResponse) some basic information about the API server (like server timestamp and API version). If you specify your credentials in the request (see TestRequest), the server will also tell if you have a valid account on the server and which language you are currently using.
| [in] | $Request | TestRequest |
| TournamentRegister | ( | stdClass | $Request | ) |
Register player to existing tournaments.
| $Request | TournamentRegister |
| Upload | ( | stdClass | $Request | ) |
Data upload using TabT-Upload format.
| $Request | UploadRequest |