FETCH jQuery API

Linking to the API

Include the following script element in the HTML.

Logging and Debugging

When implementing the API it may be necessary to see some debug information. To enable logging to the browser console use:

Callback Functions

Each method in the API takes a callback function as an optional parameter. Upon completion of the API call that function is called and the result 'object' is passed as a parameter. Should an API call fail the callback function will be called with a null value.

getDeliveryCriteriaList

Returns listing of all Course Delivery Types and descriptions

getCourseCategoryList

Returns listing of the main funding categories under which courses are run

getTargetGroupList

Returns listing of specific target groups to which a course may be assigned. Target groups are generally identified by the course category but in some cases this may be narrowed by specifying a target group for the course.

getAwardingBodyList

Returns listing of all active Awarding Bodies

getAwardList

Returns listing of all awards for a given awarding body. In the case of QQI two entries exist, one for further education and the other for higher education. These are described as QQI-FE and QQI-HE respectively

Parameters
awardingBodyID

getISCEDList

Returns listing of high level ISCED Codes and descriptions

getAreaList

Returns listing of all geographic high level areas. For areas outside of Dublin each area is equivalent to a county and there are separate areas for cities such as Cork, Limerick etc. Dublin is divided into five areas. The city is divided into north/south and there is also Dublin north county, Dublin west county and Dun Laoghaire – Rathdown.

getLocationByAreaList

Returns listing of locations in associated with a specific area. Each area contains a set of sub areas which represent towns and town lands within counties. For Dublin the sub areas represent postal codes.

Parameters
areaId

getActiveCourseLocationList

Returns listing of Locations that currently have active courses Search by ProviderId and/or AreaId

Parameters

getProviderList

Returns listing of locations in associated with a specific area. Each area contains a set of sub areas which represent towns and town lands within counties. For Dublin the sub areas represent postal codes.

getVenueList

Returns a list of venues by provider

Parameters
providerId
venueId

searchCourseListSummary

Returns listing of locations in associated with a specific area. Each area contains a set of sub areas which represent towns and town lands within counties. For Dublin the sub areas represent postal codes.

Parameters

searchCourseListSummaryAdvanced

Returns a list of courses that match an extended list of input criteria e.g. keyword. Data returned is based on the course status is active and Course Closing Date is in the future.

Note: Fields with a plural Ids are strings that can contain one or more Ids. If more than one they need to be comma-delimited.

Parameters

searchCourseReturnCourseId

Returns a list of course ID’s that match an extended list of input criteria e.g. keyword.

Note: Fields with a plural Ids are strings that can contain one or more Ids. If more than one they need to be comma-delimited.

Parameters

getIndividualCourseDetail

Returns detailed course information from the programme database and Course calendar, given the course Id

Parameters
courseId

TransportRoutesAtLocation

Search For Transport Route Stops at the given geo location

Parameters

TransportStopsOnRoute

Return all stop data for a given operator and route

Parameters