Follow

Competition XML Feed Possible Parameter Values and Info

Competition XML Feed Possible Parameter Values

Below are the possible values for the parameters and important information.

Important Information

The request must contain either the owner, clubID, countyBoardID or provinceName parameters to return competition data. If the request does not contain one of them you will receive an error message and no competition 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.

owner

Please visit the County Board and Owner IDs for Fixtures and Results XML Feed form.
http://helpdesk.servasport.com/entries/20961767-county-board-and-owner-ids-for-fixtures-and-results-xml-feed

countyBoardID

Please visit the County Board and Owner IDs for Fixtures and Results XML Feed form.
http://helpdesk.servasport.com/entries/20961767-county-board-and-owner-ids-for-fixtures-and-results-xml-feed

clubID

The id of a club.

childID

This is the division id of the competition. (This is a filtering parameter)

parentID

This is the competition group id of the competition. (This is a filtering parameter)

includeCountyComps, includeProvinceComps, includeClubComps, includeThirdLevelComps, includeSchoolComps, includeInterFirmComps

It's a "Y" or "N" value. By default it is set to "Y" so you don't need to include them in the url. You only need to include them in the url if you don't want them to be include in the xml. Therefore if includeCountyComps=N then any competitions at county level will not appear in the xml. (These are filtering parameters)

showArchive

It's a "Y" or "N" value. By default it will be set to "N" so archived competitions are NOT displayed. The showArchive parameter on the competition xml feed is different to the showArchive parameter on the results and fixtures xml feed. On the competition xml feed it reads the parameter's value (ie. the "Y" or "N" value) therefore the parameter value needs to be correct. If "Y" is given then only the archived competitions will appear in the xml. (This is a filtering parameter)

compGrade

 Must be one of the following - "Senior", "Intermediate", "Junior", "U21", "Minor", "Juvenile" or "Underage". (This is a filtering parameter)

compAgeLevel

 Must be one of the following - "U8", "U9", "U10", "U11", "U12", "U13", "U14", "U15", "U16", "U17", "U18", "U19", "U20", "U21" or "Senior". (This is a filtering parameter)

provinceNames

Must be one of the following - "Ulster", "Munster", "Leinster", "Connacht" ,"Britain", "Europe", "Ireland", "North America", "New York" or "Asia".

season

Must be number and just the year in YYYY format, for example 2009, 2011, 2013 etc. (This is a filtering parameter)

gender

If the gender parameter is used in your query then this will pull in only Ladies competition regardless if the value "M" or "F" is used. This parameter should only be included in your call if you only want to return ladies competitions. (This is a filtering parameter)

discipline

Must be either "football" or "hurling". If it is set to "football" then both male and female football competitions appear. If it is set as "hurling" then ONLY male hurling competitions are displayed. To see female hurling competitions (Camogie) you need to include the gender parameter with the value "F", for example api/competitions/xml?owner=11223344&discipline=hurling&gender=F. (This is a filtering parameter)

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

Comments