ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.GetWebOccurrencesOverlappingDateRangeForProgramme Method

Get all Web Occurrences on offer during a date range for a programme. 

Returns an Authenticated Occurrence List containing all of the Web Occurrences, which overlap the given date range, and are in the specified programme. 

Each Occurrence is represented by a TOccu. The collection of Occurrences is represented by a List of TOccu

A token is passed for authentication. If the authentication fails, or other errors occur, no occurrences are returned. The result of the authentication is represented by a TAuthenticate object. 

A date range is passed as two parameters, rangeStart and rangeEnd, which define the end points of the date range. The ID of the programme is passed in the programmeId parameter. An occurrence will be returned in the Occurrence List, if any date for which the occurrence is offered (from it startdate to its enddate) co-incides with any date in the date range (including end points), and the occurrence is in the programme. 

This function is similar to GetWebOccurrencesForProgrammeAndDates. GetWebOccurrencesForProgrammeAndDates returns a subset of occurrences returned by this function. That subset is limited to those occurrences starting within the date range and having available places in the occurrence. 

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.

C#
[WebMethod(Description = "Gets a list of web-enabled occurrences within the specified date range for the specified programme")]
public TAuthOccuList GetWebOccurrencesOverlappingDateRangeForProgramme(string token, DateTime rangeStart, DateTime rangeEnd, int programmeId);
Parameters 
Description 
string token 
String containing a token. 
DateTime rangeStart 
Date, start of date range in which to find Occurrences. 
DateTime rangeEnd 
Date, end of date range in which to find Occurrences. 
int programmeId 
Integer, ID of the Programme in which to find Occurrences. 

TAuthOccuList : an authenticated list of Occurrences.

Copyright (c) VETtrak 2022. All rights reserved.