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

Get the List of available Web Occurrences that have been changed since a date for a Programme in a Date Range. 

This is a listing of all of the Occurrences, that have been created or modified since a date, of a given Programme, which start within the date range and have available places. 

Only Occurrences that have been created or modified after the supplied sinceDate will be returned. An Occurrence will be considered to be modified if it, or any of its classes, units or prices, have been created or modified. 

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

A date range is passed as two parameters, startDate and endDate, 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. 

A Programme ID is passed as a parameter: programmeId. 

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. 

Requires a valid registration key entry for the Short Courses feature.

C#
[WebMethod(Description = "Gets a list of web-enabled occurrences within the specified date range and with the specified programme ID that have available places")]
public TAuthOccuList GetWebOccurrencesForProgrammeAndDatesSince(string token, int programmeId, DateTime startDate, DateTime endDate, DateTime sinceDate);
Parameters 
Description 
string token 
String containing a token. 
int programmeId 
Integer, ID of Programme. 
DateTime startDate 
DateTime, start of date range in which to find Occurrences starting. 
DateTime endDate 
DateTime, end of date range in which to find Occurrences starting. 
DateTime sinceDate 
DateTime, only Occurrences created or modified after this date are returned. 

TAuthOccuList : an authenticated list of Occurrences.

Copyright (c) VETtrak 2022. All rights reserved.