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

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

This is a listing of all of the Programmes of a given Programme Type, for which there is a web occurrence starting within the date range and having 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. These are DateTime objects 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 Type Name is passed as a parameter: sPrgt_Name. 

Available places means that the number of students enroled is less than the maximum number allowed for the occurrence. 

Each Programme item is represented by a TProg. The collection of Programme items is represented by a List of TProg

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. 

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 programmes of the specified programme type with a web-enabled occurrence in the specified date range that has available places")]
public TAuthProgList GetWebProgrammesForProgTypeAndDates(string sToken, string sPrgt_Name, DateTime xsdStart, DateTime xsdEnd);
Parameters 
Description 
string sToken 
String containing a token. 
string sPrgt_Name 
String, name of Programme Type. 
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. 

TAuthProgList : an Authenticated list of Programme items.

Copyright (c) VETtrak 2022. All rights reserved.