|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.GetContractsForStaff Method
|
ASP.NET VETtrak API web services
|
|
|
Get the List of Trainees and Contracts for a Staff Member.
This is a listing of all Contracts for which the Staff Member has a role. This function also returns the client (trainee) linked to the contract, and details of the role of the staff member.
Each resulting item is refered to as a Contract Staff item.
Each Contract Staff item is represented by a TContStaff. The collection of Contract Staff items is represented by a List of TContStaff.
Each TContStaff item contains information on the Client, the Contract, and the Staff Member's role under the Contract.
A token is passed for authentication. If the authentication fails, or other errors occur, no contract staff items are returned. The result of the authentication is represented by a TAuthenticate object.
[WebMethod(Description = "Gets a list of trainees and their contracts assigned to the staff member with the specified client code")] public TAuthContStaffList GetContractsForStaff(string sToken, string sClie_Code);
|
Parameters |
Description |
|
string sToken |
String Token. |
|
string sClie_Code |
String containing the Client Code of the Staff Member. |
TAuthContStaffList : an authenticated list of all Contract Staff items for the Staff Member.
Does not include data relating to students who decline to have their details published.
Requires a valid registration key entry for the Trainee Management feature.
This function has security level "Restricted". Users that have explicitly been granted permission to the API can use it with any parameters, otherwise, the logged-in client can only access their own data.
|
Copyright (c) VETtrak 2022. All rights reserved.
|
