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

Get details of a Web Enrolment. 

This is a listing of details of a particular Web Enrolment. 

The Web Enrolment is represented by a TWebe

A web enrolment ID (iWebe_ID) is passed as a parameter. iWebe_ID must specify a valid Web Enrolment, which can be either a Client Web Enrolment or an Employer Web Enrolment. 

This function could be used to verify changes to the enrolment. In particular, it might be used after the AddWebPayment function has been called. 

A token is passed for authentication. If the authentication fails, or other errors occur, no Web Enrolment is 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 the details of the web enrolment with the specified ID")]
public TAuthWebe GetWebEnrolment(string sToken, int iWebe_ID);
Parameters 
Description 
string sToken 
String containing a token. 
int iWebe_ID 
Integer ID of Web Enrolment. 

TAuthWebe : an Authenticated Web Enrolment.

Copyright (c) VETtrak 2022. All rights reserved.