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

Set the LMS Status of an (LMS) Occurrence. 

Use this function to change the LMS Status of an LMS Occurrence. In this context, an LMS Occurrence means an Occurrence in VETtrak which has the ENRO_LMS_PUBLISH flag set to 1. The LMS Status is the value of the ENRO_LMS_STATUS field of an Occurrence record. 

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

Valid values of LMS Status are:

  • LMS Status = 0, means Occurrence is NOT in LMS,
  • LMS Status = 1, means Occurrence 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 Occurrence in the LMS, which replicates an LMS Occurrence already existing in VETtrak. 

By setting the LMS Status of an LMS Occurrence to 1, this occurrence will not be included in the listing returned by future calls to GetLMSNewOccurrences

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 LMS occurrence with the specified ID has been sent to the LMS")]
public TAuthenticate UpdateLMSOccurrenceStatus(string sToken, int iID, int iStatus);
Parameters 
Description 
string sToken 
String containing a token. 
int iID 
Integer ID of the Occurrence. 
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.