|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.GetTraineeEventsForStaff Method
|
ASP.NET VETtrak API web services
|
|
|
Get the Trainee Event List for a Staff Member.
This is a listing of all Events for all Trainees for which the Staff Member has a role, where the event starts within a date range.
A date range is passed as two parameters, xsdStart and xsdEnd, which define the end points of the date range. These are DateTime objects where the time component is significant. They must be populated with sensible dates (Start > End), otherwise, an input error results.
Each Event item is represented by a TEven. The collection of Event items is represented by a List of TEven.
A token is passed for authentication. If the authentication fails, or other errors occur, no event items are returned. The result of the authentication is represented by a TAuthenticate object.
[WebMethod(Description = "Gets a list of events against any trainees assigned to the staff member with the specified client code in a date range")] public TAuthEvenList GetTraineeEventsForStaff(string sToken, string sClie_Code, DateTime xsdStart, DateTime xsdEnd);
|
Parameters |
Description |
|
string sToken |
String Token. |
|
string sClie_Code |
String containing the Client Code of the Staff Member. |
|
DateTime xsdStart |
DateTime, start of date range in which to find Events. |
|
DateTime xsdEnd |
DateTime, end of date range in which to find Events. |
TAuthEvenList : an authenticated list of all Event 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 Event 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.
|
