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

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

This is a listing of all of the Occurrences of a given Programme, 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. 

A Programme ID is passed as a parameter: iProg_ID. 

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 GetWebOccurrencesForProgrammeAndDates(string sToken, int iProg_ID, DateTime xsdStart, DateTime xsdEnd);
Parameters 
Description 
string sToken 
String containing a token. 
int iProg_ID 
Integer, ID of Programme. 
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) OzSoft Solutions 2016. All rights reserved.