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

Get all Clients for a Host Employer. 

Returns an Authenticated Basic Client List containing all of the trainees whose latest placement is with the employer. 

Each Trainee is represented by a TClie. The collection of Trainees is represented by a List of TClie

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

An Employer Identifier is passed as a parameter. Valid Employer Identifiers are string representations of integers which match employers in the database.

C#
[WebMethod(Description = "Gets a list of clients whose latest placement is with the employer with the specified ID")]
public TAuthClieList GetClientsForHostEmployer(string sToken, string sEmpl_Identifier);
Parameters 
Description 
string sToken 
String Token. 
string sEmpl_Identifier 
String Employer Identifier. 

TAuthClieList : an authenticated list of basic clients.

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

Requires a valid registration key entry for the Placements 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.