Gets a list of regions for web-published occurrences with available places, that are for a specified programme and/or start in a specified date range.
You can use this function to give a user a list of available regions to filter by. After the user selects a regions, you can call SearchWebOccurrences to find details of occurrences with that region.
Either a programmeId, or a startDate and endDate, or both, need to be specified.
You can use GetWebProgrammes, GetWebProgrammesForDates, GetWebProgrammesForProgType or GetWebProgrammesForProgTypeAndDates to find a programmeId to filter by.
The test for web occurrence start date, being within the date range, is inclusive of end points.
Available places means that the number of students enrolled is less than the maximum number allowed for the occurrence.
Each regions item is represented by a TRegion. The collection of regionss is represented by a List of TRegion.
A token is passed for authentication. If the authentication fails, or other errors occur, no regions are returned. The result of the authentication is represented by a TAuthenticate object.
Requires a valid registration key entry for the Short Courses feature.
This function has security level "Protected", and can only be accessed by users that have explicitly been granted permission to the API.
[WebMethod(Description = "Gets a list of regions with a web-enabled occurrence in the specified programme and/or date range that has available places")] public TAuthRegionList GetWebRegionsForProgrammeAndDates(string token, int? programmeId, DateTime? startDate, DateTime? endDate);
Parameters |
Description |
string token |
String containing a token. |
int? programmeId |
Optional integer ID of the programme to find occurrences for. Specify null or 0 to not filter on programme. |
DateTime? startDate |
Optional DateTime, start of date range in which to find occurrences starting. If this is specified, endDate must also be specified. Specify null, for both this and endDate, to not filter on date. |
DateTime? endDate |
Optional DateTime, end of date range in which to find occurrences starting. If this is specified, startDate must also be specified. Specify null, for both this and startDate, to not filter on date. |
TAuthRegionList list of regions of web published occurrences with available places matching the specified criteria
Copyright (c) VETtrak 2022. All rights reserved.
|