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

Get the List of new LMS Enrolments for an Occurrence. 

This is a listing of all LMS Client and Employee Occurrence Enrolments which exist in VETtrak but don't exist in the Learning Management System (LMS) for a particular Occurrence. (So these enrolments are new to the LMS.) 

These are enrolments that are flagged as LMS enrolments, and are not flagged as having been previously created in the LMS. 

Each Enrolments is represented by a TClieEnro. The collection of Enrolments is represented by a List of TClieEnro

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

It is envisaged that an LMS system would call this function on a (very) regular basis, and use the resulting Enrolments to generate equivalent Enrolments in the LMS. 

Having successfully replicated an Enrolment in the LMS, the LMS would advise VETtrak to flag the successful creation of the Enrolment on the LMS by calling the function: 

 

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 enrolments for the LMS-enabled occurrence with the specified ID that have not yet been sent to the LMS")]
public TAuthClieEnroList GetLMSNewEnrolmentsForOccurrence(string sToken, int iID);
Parameters 
Description 
string sToken 
String containing a token. 
int iID 
Integer ID of Occurrence. 

TAuthClieEnroList : an authenticated list of LMS Enrolments.

Copyright (c) VETtrak 2022. All rights reserved.