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

Update the LMS Status of an (LMS) Enrolment. 

Use this function to change the LMS Status of an LMS Enrolment. In this context, an LMS Enrolment means a client occurrence enrolment in VETtrak which belongs to an occurrence that has the ENRO_LMS_PUBLISH flag set to 1. The LMS Status is the ENRO_LMS_STATUS field of an Enrolment record. 

An Enrolment ID (iID) is passed as a parameter. iID must specify an Enrolment which is an LMS Enrolment, otherwise, the LMS Status is not updated. 

Valid values of LMS Status are:

  • LMS Status = 0, means Enrolment is NOT in LMS,
  • LMS Status = 1, means Enrolment IS in LMS.
 

An LMS Status value (iStatus) is passed as a parameter. This must take one of the valid values (above), otherwise, no update is performed. 

This function should be called after successfully creating an Enrolment in the LMS, which replicates an LMS Enrolment already existing in VETtrak. 

By setting the LMS Status of an LMS Enrolment to 1, this enrolment will not be included in the listing returned by future calls to GetLMSNewEnrolmentsForOccurrence 

A token is passed for authentication. If the authentication fails, or other errors occur, no update is performed. 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 = "Updates whether or not the enrolment with the specified ID, in a LMS-enabled occurrence, has been sent to the LMS")]
public TAuthenticate UpdateLMSEnrolmentStatus(string sToken, int iID, int iStatus);
Parameters 
Description 
string sToken 
String containing a token. 
int iID 
Integer ID of Enrolment. 
int iStatus 
Integer LMS Status. 

TAuthenticate : a TAuthenticate object containing the status of the update. This contains properties Status and StatusMessage which will indicate if the update is successful.

Copyright (c) OzSoft Solutions 2016. All rights reserved.