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

Get the Client List for a Training Class. 

This is a listing of all Clients for a single Class (or Instance item). 

Each Client is represented by a TClie. The collection of Clients is represented by a List of TClie

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

C#
[WebMethod(Description = "Gets a list of clients enrolled in the class (instance) with the specified ID")]
public TAuthClieList GetClientsForClass(string sToken, int iInst_ID);
Parameters 
Description 
string sToken 
String Token. 
int iInst_ID 
Integer containing the ID of the Instance. 

TAuthClieList : an authenticated list of all Clients for the Instance.

Does not include data relating to trainees who decline to have their details published. 

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.

Copyright (c) VETtrak 2022. All rights reserved.