Follow

Competition XML Feed

Competition Feed Developer Summary

Returning XML from the Server

There is a servlet located at api/competitions/xml. For testing and development purposes this servlet can be accessed from the Servasport development server at:

http://people.gaa.ie/api/competitions/xml

The servlet will take the following parameters:

ID Parameters

  • countyBoardID=1234

                Get all competitions for clubs from County Board 1234

  • owner=1234

                Gets all of the competitions that a county, province or national user owns.

  • clubID=1234

                Will return all competitions that the given club is participating in.

  • childID=1234

                Will return competition data for the competition with the child id of 1234. This will also only show the given child, all other children within this competition will not be displayed. (Filtering parameter)

  • parentID=1234

                Will return competition data for the competition with the id of 1234. All children of the competition will be shown. (Filtering parameter)

Include Parameters

  • includeCountyComps= Y/N

               Include competitions that the County is participating in.(always defaulted to Y when it's not included (Filtering parameter)

  • includeProvinceComps= Y/N

               Include competitions that the province is participating in.(always defaulted to Y when it's not included) (Filtering parameter)

  • includeClubComps= Y/N

               Include competitions that clubs are participating in.(always defaulted to Y when it's not included) (Filtering parameter)

  • includeThirdLevelComps= Y/N

               Include competitions that the third level club is participating in.(always defaulted to Y when it's not included) (Filtering parameter)

  • includeSchoolComps= Y/N

               Include competitions that the school is participating in.(always defaulted to Y when it's not included) (Filtering parameter)

  •  includeInterFirmComps= Y/N

              Include competitions that the Inter-Firm is participating in.(always defaulted to Y when it's not included) (Filtering parameter)

Y/N Parameters

  • showArchive=Y/N

               If your site has an archive section, this parameter is needed and must be set as "Y" to display the historical competitions, as by default the feed will not return archived competitions. (Filtering parameter)

Variable Parameters

  • compGrade=(Senior, Intermediate, Junior, U21, Minor, Juvenile, Underage)

             Get all the competitions for that grade. (Filtering parameter)

  • compAgeLevel=(Senior, U21, U20, U19, U18, U17, U16, U15, U14, U13, U12, U11, U10, U9, U8)

             Get all competitions for that age level. (Filtering parameter)

  • provinceName=(Ulster, Munster, Leinster, Connacht, Ireland, Britain, North America, Europe, New York, Asia)

             Returns all competitions for the named province.

  • season=(2010)

              Will return competitions for the chosen season. If you are searching for historical competitions then you might need to include the showArchive parameter if the competition is archived. (Filtering parameter)

  • gender=(M/F)

              Will return competitions of the chosen gender. By default it will display both male and female competitions. (Filtering parameter)

  • discipline=(football/hurling)

             Will return competitions to display only those of the particular discipline. If you specify "hurling" it will default to show only male hurling competitions. To see female hurling competitions (camogie) please also use the gender parameter and set it as "F". (Filtering parameter)

Important Notes:

The request made must contain one of the following four parameters = owner, clubID, countyBoardID or provinceName. If the request does not contain one of them you will receive an error message and no competitions data will be returned. Therefore the following parameters are used as filters =  childID, parentID, season, grade, gender, discipline, compAgeLevel, showArchive, includeCountyComps, includeProvinceComps, includeClubComps, includeThirdLevelComps, includeSchoolComps, includeInterFirmComps.

 

An example of a typical query to the servlet might be:

http://people.gaa.ie/api/competitions/xml?owner=1845&discipline=hurling&gender=F

The above example will return all camogie competitions that belongs to the owner 1845.

 

In response you will get an XML document with the requested info.

At this point the XML may be parsed with whatever tools are at the developers disposal and displayed however is seen fit.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments