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

Get the List of available Web Occurrences in a Date Range. 

This is a listing of all of the Occurrences, which start within the date range and have available places. 

Web occurrence means an occurrence which is published on the web. 

A date range is passed as two parameters, xsdStart and xsdEnd, which define the end points of the date range where the time component is significant. They must be populated with sensible dates (Start > End, is not considered sensible), otherwise, an input error results. 

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 enroled is less than the maximum number allowed for the occurrence. 

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

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

This function is similar to GetWebOccurrencesOverlappingDateRange. The difference is that GetWebOccurrencesOverlappingDateRange returns all web occurrences overlapping the date range, while this function only returns occurrences starting within the date range which have available places. 

This function returns web occurrences which are avialable for new enrolments. 

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 that have available places")]
public TAuthOccuList GetWebOccurrencesForDates(string sToken, DateTime xsdStart, DateTime xsdEnd);
Parameters 
Description 
string sToken 
String containing a token. 
DateTime xsdStart 
DateTime, start of date range in which to find Occurrences starting. 
DateTime xsdEnd 
DateTime, end of date range in which to find Occurrences starting. 

TAuthOccuList : an authenticated list of Occurrences.

Copyright (c) VETtrak 2022. All rights reserved.