Examples of Requests to the APIs

CONTENTS

Overview

Club Fixtures and Results

County Fixtures and Results

Provincial Fixtures and Results

___________________________________________

Overview

Here are some examples to help you get the most out of the Fixtures and Results API.

Please remember that in order to return competition data you must include one of the following parameters within your request to the API:

• owner
• provinceName
• countyBoardID
• clubID

You may use the filtering parameters listed within the ‘Parameters for GAA Competition APIs’ section to find the exact competition data you require.

Club Fixtures and Results

Examples of requests	Parameter IDs and Values
To display all fixtures and results, at all levels for a particular club	clubID=****
To display results only	clubID=****&resultsOnly=Y
To display fixtures only	clubID=****&fixturesOnly=Y
To then filter the fixtures to show only senior fixtures	clubID=****&fixturesOnly=Y &compLevel=Senior
To display all senior club fixtures at County level	countyBoardID=1234&compLevel=Senior& includeCollegeGames=N &fixturesOnly=Y&includeCountyGames=N &includeSchoolGames=N
To display all senior club fixtures at provincial level	provinceName=Ulster&compLevel=Senior& includeCollegeGames=N &fixturesOnly=Y&includeCountyGames=N &includeSchoolGames=N
To display only the senior provincial fixtures for a particular club	provinceName=Ulster&compLevel=Senior &includeCollegeGames=N&fixturesOnly=Y &includeCountyGames=N &includeSchoolGames=N&clubID=****
To display all senior club fixtures at National level	compLevel=Senior&includeCollegeGames=N &fixturesOnly=Y&includeCountyGames=N &compLevel=Senior&includeProvincialGames=N &includeSchoolGames=N
To display a specific fixture for a senior team that has a date	clubID=****&compLevel=Senior &dateFrom=20110722&dateTo=20110723 &fixturesOnly= Y OR uniqueID=42415 (Get the result/Fixture for the specific game)
To display the League table for a competition	compID=@@@@&leagueTableOnly=Y

County Fixtures and Results

Examples of requests	Parameter IDs and Values
To display all the club fixtures within your county	countyBoardID=####&includeSchoolGames=N &includeCollegeGames=N&fixturesOnly=Y
To then wanted to filter those fixtures to show only minor games;	countyBoardID=####&includeSchoolGames=N &includeCollegeGames=N&compLevel=Minor &fixturesOnly= Y
To display all the fixtures the county team is competing in, within their province;	provinceName=Ulster&clubID=**** (with the id being the county ID)
To display all the games in a competition which your county is competing in at a provincial level	provinceName=Ulster&includeSchoolGames=N &includeClubGames=N &includeCollegeGames=N &includeCountyGames=N&fixturesOnly=Y
To show all the games in a competition which your county is competing in at a National level	includeSchoolGames=N & includeClubGames=N& includeCollegeGames=N& includeProvincialGames=N&fixturesOnly=Y
To display all the games your senior county team is competing in, in all competitions	clubID=****&compLevel=Senior
To display all the fixtures for a specific competition	compID=@@@@

Provincial Fixtures and Results

Examples of requests	Parameter IDs and Values
To display all senior club fixtures in a province	provinceName=Ulster&compLevel=Senior &includeCollegeGames=N &fixturesOnly=Y&includeCountyGames=N &includeSchoolGames=N
To filter those results for a particular county	provinceName=Ulster&compLevel=Senior &includeCollegeGames=N&fixturesOnly= &includeCountyGames=N&includeSchoolGames=N &countyBoardID=####
To show all Senior county games in a province	provinceName=Ulster&compLevel=Senior &includeCollegeGames=N&fixturesOnly=Y &includeClubGames=N &includeSchoolGames=N&includeCountyGames=N
To show all Senior County games at a National Level	compLevel=Senior & includeCollegeGames =N & fixturesOnly= Y & includeClubGames=N & includeSchoolGames =N & includeClubGames=N & includeCountyGames=N & includeProvincialGames =N
To Display all fixtures for a specific competition in your province	compID=@@@@

KEY

#### - This denotes a county board ID, each county will have a different ID. If you contact GMS Support directly we can provide you with the ID you require

@@@@ - This denotes a competition ID, each competition will have a unique competition ID that will change every year. If you liaise with your county board or contact GMS Support directly directly you can obtain this ID.

**** - This denotes a Club ID, each club will have a different ID. If you liaise with your county board or contact GMS Support directly directly you can obtain this ID.