Service Updates

Notes on changes to the FETCH API and Widget

Widget Version 1.7

Change To: Widget
Release Date: 31/08/2017
Version: 1.7.2
Notes Changes
New Flag
isced. This flag constrains the widget to only include courses that belong to the specified ISCED (International Standard Classification of Education) categories.

iscontracted. This flag constrains the widget to either only show courses that are contracted (=1) or exclude courses that are contracted (=0)


Wording
The course details now mentions Charges instead of Fees

API Version 1.7.2

Change To: FETCH Service API
Release Date: 31/08/2017
Version: 1.7.2
Notes: Changes
Updated SearchCourseListSummaryAdvanced to include 1 new parameter: IsCourseContracted
The new parameter can filter results to only include Contracted Courses (when = 1) or to exclude Contracted Courses (when =0)

Updated SearchCourseListSummaryAdvanced in how it handles ISCED codes. It now includes detailed ISCED codes as well as the broad ISCED codes it already did.
For a live demonstration see Web Service and jQuery API

Widget Version 1.6

Change To: Widget
Release Date: 28/04/2017
Version: 1.6
Notes Changes
Geolocation Fields
The Search Parameter object field names have been changed to match the API service version 1.7. 3 new field names have been added:
Latitude, Longitude and RangeMeters . These fields enable you to search for courses with venues at a given location within a given range.

New
For advanced integration with host sites using Bootstrap 4, a new data flag has been added BS4. Basic integration on host sites using Bootstrap 4 should not need this flag.

Fixes
setFilters() function was not setting the Delivery Mode drop down to match the given sfcw-deliverymodeid url parameter.

API Version 1.7

Change To: FETCH Service API
Release Date: 28/04/2017
Version: 1.7
Notes: Changes
Updated SearchCourseListSummaryAdvanced to include 5 new parameters.
The new parameters are: Latitude, Longitude, RangeMeters, TransportRouteName and TransportRouteOperator.
The first 3 parameters enable a search to only include courses in certain radius of a given location.
The last 2 parameters enable a search to only include courses whose venue is within walking distance of transport stops belonging to the given route and operator. For a live demonstration see Web Service and jQuery API

Add a new boolean response field to GetIndividualCourseDetail called IsOlcaEnabled. This field indicates whether the course is available for Online Applications.

New
New Endpoint - TransportRoutesAtLocation which returns a list of public transport stops in the given location within the given radius. You can try it out here.

New Endpoint - TransportStopsOnRoute which returns a list of public transport stops that belong to the given operator and route. You can try it out here.

Widget Version 1.5

Change To: Widget
Release Date: 23/01/2017
Version: 1.5
Notes Changes
Multiple IDs
The Search Parameter object field names have been changed to match the API service. Field names have been made plural to indicate that they can take more than one id (in comma delimted format)
ProviderIds, ISCEDIDs, CategoryIds, AreaIds, LocationIds, TargetAwardIds, TargetAwardingBodyIds

The Widget can be set up to show course search results from multiple course providers. The data-providerId attribute can accept a list of ids separated by commas.

Events
The timing of the call to the function specified in data-callback has been changed to make it more efficient.

Print Button
Course detail printing has changed. It no longer pops up a new window. Rather it uses CSS to hide other page elements so that only the course details are printed in the original format.

Note: Print quality and layout is determined by browser type, operating system and the capabilities of the printer.

Venue
sfcw-data-providerName now contains the FET Provider's name and not the Venue's name.

Erratum
The documentation for Events have been corrected to show that they are not functions but are function pointers that can be assigned to.

New
As well as the existing sfcw-courseid parameter, 7 additional parameters have been added so that the widget controls can be filled in from another page:
sfcw-iscedid
sfcw-categoryid
sfcw-areaid
sfcw-locationid
sfcw-targetawardingbodyid
sfcw-targetawardid
sfcw-deliverymodeid

Course Details Toolbar
Save/Remove Favourite and Print Buttons are created dynamically in the init function using a public method called addCourseToolbarButton. This is a public method that enables the developer to dynamically add custom buttons to the toolbar.

Events
A new event handler has been added to facilitate integration in to host Websites: event_resultView

FurtherDetails
A new course detail field has been added to PLSS called FurtherDetails. The widget has a new class to display this: sfcw-data-furtherDetails.

VenueName
The widget has a new class to display the course Venue Name: sfcw-data-venueName. Note: the sfcw-data-providerName now contains the FET Provider's name and not the Venue's name as before.

DIV Controls
There are two new div/control ids that the widget uses to show and hide course details depending on whether there is data available for them:
sfcw_div_furtherDetails
sfcw_div_learningOutcomes

API Version 1.6

Change To: FETCH Service API
Release Date: 16/12/2016
Version: 1.6
Notes: Changes
Updated SearchCourseListSummaryAdvanced and SearchCourseReturnCourseId to include 6 new parameters.
The new parameters are: AreaIds, LocationIds, CategoryIds, ISCEDIds, TargetAwardIds, TargetAwardingBodyIds.
Each of these parameters can accept a value which is a comma-delimited string of Ids for their respective search parameter.

6 existing parameters are being deprecated over time: AreaId, LocationId, CategoryId, ISCEDId, TargetAwardId, TargetAwardingBodyId
See Web Service and jQuery API

A new field has been added to getIndividualCourseDetail: FurtherDetails.
See Web Service and jQuery API

Widget Version 1.4

Change To: Widget
Release Date: 18/10/2016
Version: 1.4
Notes Security
This release introduces the use of SSL for encryption. All FETCH services are now SSL enabled and all the Widget API calls use HTTPS.

It is strongly recommended that the script tag is changed to HTTPS. This has been reflected in the documentation.

Integration Features
These features have been included for developers who want tighter integration with the widget.
data-flag setting bs4; instructs the widget to use Bootstrap 4 class names instead of the usual Bootstrap 3. Note: Currently the widget still only loads the Bootstrap 3 framework so this is for those doing a complete customization of the Widget HTML.

Event Handlers
Various event handlers have been added to the Widget. A developer can assign custom functions to these as shown in the documentation.
  • event_searchComplete
  • event_addFavouriteCourse
  • event_removeFavouriteCourse
  • event_courseView
The SearchParameters object has a new field: ResultCount. It holds the search result total and is updated after every search.

New Methods
Some new public methods have been added to the Widget. See Methods in the documentation.
  • searchParameters() returns the searchParameters object
  • setFilters() which takes a searchParameters object and sets the filter control values
  • setCourseFields() which uses the current course object and populates any html fields with data
  • getCourseObject() returns the _currentCourse object

data-flag setting nohistory; instructs the widget to not adjust the page history object. Used when the widget is in a Single Page Application with its own page history handling.

Changes
The sfcw.api.getVenueList method has been given an additional parameter: venueId. This brings the jQuery method inline with the matching FETCH API call.

sfcw.api.getVenueList(providerId, venueId, function(result) { console.log(result); });

test here

The sfcw.api object methods now all return the jQuery $.ajax object that it uses so the developer can perform chaining and use them in Javascript Promises.

Widget Version 1.3

Change To: Widget
Release Date: 10/10/2016
Version: 1.3
Notes Features
fullwidth
A new setting for websites that are restricted in page width. Set the data-style keyword to fullwidth

<script src= "https://widget.fetchcourses.ie /sfcw_init" data-style="fullwidth"></script>

This will force the widget to use the full width of the page.

Fixes
lazy-loading - now works correctly with automatic initial searches when the data-keyword attribute is used.
The initiateNewSearch function checks if the course details section is open before closing it
- this prevents the page from calling scrollTop() (from closeCourse()) on an initial page load with automatic initial search

Widget Version 1.2

Change To: Widget
Release Date: 23/09/2016
Version: 1.2
Notes Fixes
lazy-loading - only the first 10 courses were being loaded if the page was too big for scrolling. Now the search calls 'lazyLoad_ExtraSearch'
Widget was not functioning correctly for iPad and iPhone users - now working
Courses Map now shows the contact details correctly when the user clicks on the Google Pin.

Features
Browser history (HTML5 only)
Opening Course Details causes the browser's history to be added to. So if the user presses the back-button they will be able to go back (and forward) course by course.
Also when viewing a course the URL is altered to include ?courseId= so that if page is bookmarked it will work
Limitations:
* does not include search results sub-section map or sub-section favourites - always goes back to list * does not remember previous search results. Any time pressing back and forward shows the search results screen it is showing the latest results.

The widget now has a hidden course Id field in the course details section. Any element with class a sfcw-data-courseId will be given the course Id in the course details section

API Version 1.5

Change To: FETCH Service API
Release Date: 31/07/2016
Version: 1.5
Notes: Features
Added new method GetVenueList which returns Venue details by ProviderId or VenueId.
See Web Service and jQuery API

Updated SearchCourseListSummaryAdvanced and SearchCourseReturnCourseId to include Request parameter VenueId
See Web Service and jQuery API

Added two new fields to getIndividualCourseDetail: EveningsAttendancePercent and EveningsDaysPerWeek
See Web Service and jQuery API

Widget Version 1.1

Change To: Widget
Release Date: 30/08/2016
Version: 1.1
Notes Reorganization of javascript
Widget now across 4 javascript objects sfcw, sfcw.widget, sfcw.api and sfcw.map
sfcw.api encapsulates all FETCH api calls for the widget. Developers can choose to use this directly to build their own search tools - see jQuery Api

Behavior
course details - now showing timetable for all delivery types

Features
New Google Map Feature
A table added for map information when the search is called from the map and the result-set is constrained.
Also a control to close the search result and show the map

sfcw
looks for data-map attribute. If 'integrated' will load widget_section_map.html section and
google maps api looks for data-googleapikey attribute. Used to load google api

Other
Added lazy-loading feature. This is now the default. To use pagination instead do data-flags="pagination;"
Added print capability and 'save to favourites' buttons
course search - added filter capabilities for delivery type, programme, award, awarding body etc.
course results - added map results and favourites view capabilities

feedback fixes
Overlay image pointing to local relative url
Now points to http: // widget.fetchcourses.ie/content/graphics/loader-white.gif

Script tags - looks in head as well as body sections on the html page - for EBOW users

API Version 1.4

Change To: FETCH Service API
Release Date: 31/07/2016
Version: 1.4
Notes: Fix
Fixed a typo in SearchCourseReturnCourseId

API Version 1.3

Change To: FETCH Service API
Release Date: 19/07/2016
Version: 1.3
Notes: Features
Added a new method GetActiveCourseLocationlist
Returns listing of Locations that currently have active courses Search by ProviderId and/or AreaId
More information