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

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

This is a listing of all of the Programme Type items, for which there is a web occurrence which starts within the date range and has 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. 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 Programme Type item is represented by a TPrgt. The collection of Programme Type items is represented by a List of TPrgt

A token is passed for authentication. If the authentication fails, or other errors occur, no programme types 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 programme types with a web-enabled occurrence in the specified date range that has available places")]
public TAuthPrgtList GetWebProgrammeTypesForDates(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. 

TAuthPrgtList : an Authenticated list of Programme Type items.

Copyright (c) VETtrak 2022. All rights reserved.