Delete a Web Enrolment.
A Web Enrolment ID (iWebe_ID) is passed as a parameter. This should be the ID returned by the function used to create the enrolment: AddClientWebEnrolment or AddEmployerWebEnrolment.
If the iWebe_ID parameter specifies an Employer Web Enrolment, DeleteWebEnrolment removes the Employer Web Enrolment and all of the details for all of the Employees linked to the Enrolment.
Successful execution of this function removes applicatable records from the WEBENROL, WEBCOMPANY, WEBCLIENT, WEBCLIENTAVETMISS, WCAVDISA and WCAVPRED tables.
On the other hand, if iWebe_ID specifies a Client Web Enrolment, DeleteWebEnrolment removes the Client Web Enrolemnt and all of the associated Client details.
Successful execution of this function removes applicatable records from the WEBENROL, WEBCLIENT, WEBCLIENTAVETMISS, WCAVDISA and WCAVPRED tables.
A token is passed for authentication. If the authentication fails, or other errors occur, nothing is deleted. 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, or users with access to the "API Functions" feature in the VETtrak application.
[WebMethod(Description = "Deletes the web enrolment with the specified ID")] public TAuthenticate DeleteWebEnrolment(string sToken, int iWebe_ID);
Parameters |
Description |
string sToken |
String containing a token. |
int iWebe_ID |
Integer ID of Web Enrolment. |
TAuthenticate : an Authenticate Object containing the result of the deletion. The StatusMessage property of the result advises details of records deleted, or of any errors.
Copyright (c) VETtrak 2022. All rights reserved.
|