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

Get all Employees for an Employer. 

Returns an Authenticated Basic Client List containing all of the employees (in the database) for the employer, according to the Active Status requested. Valid Active Status (parameter iActiveStatus) values are: 

  • iActiveStatus = 0 => Active & Inactive,
  • iActiveStatus = 1 => Active Only,
  • iActiveStatus = 2 => Inactive Only.
 

Each Employee is represented by a TClie. The collection of Employees is represented by a List of TClie

A token is passed for authentication. If the authentication fails, or other errors occur, no employees 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 employees (active and/or inactive) for the employer with the specified ID")]
public TAuthClieList GetEmployeesForEmployer(string sToken, string sEmpl_Identifier, int iActiveStatus);
Parameters 
Description 
string sToken 
String Token. 
string sEmpl_Identifier 
String Employer Identifier. 
int iActiveStatus 
Integer Active Status of Employee,
  • 0 returns Active & Inactive Trainees.
  • 1 returns Active Trainees Only.
  • 2 returns Inactive Trainees Only. 

TAuthClieList : an authenticated list of basic clients.

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

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.