|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.GetStaffForOccurrence Method
|
ASP.NET VETtrak API web services
|
|
|
Gets a list of staff members that are associated with an occurrence or booking in various ways.
This will return staff that are associated with the occurrence through the occurrence itself and/or the occurrence's classes. For the occurrence itself, you can optionally only include staff members when the staff member is assigned with a particular type.
The results are represented in a list of TClieStaffLinks, one per staff member that is linked in any way. Each one contains the staff member itself in a TClie. Each one also contains a list of TStaffLink that describes each way that this staff member is linked to the occurrence.
A token is passed for authentication. If the authentication fails, or other errors occur, no data will be returned. The result of the authentication is represented by a TAuthenticate object.
Requires a valid registration key entry for the Short Courses feature.
This function has security level "Unrestricted", and can be accessed by any authenticated user.
[WebMethod(Description = "Gets a list of staff members associated with an occurrence in various ways")] public TAuthClieStaffLinksList GetStaffForOccurrence(string token, int occurrenceId, bool includeClasses, bool includeOccurrence, string staffType);
|
Parameters |
Description |
|
string token |
Mandatory string containing a token. |
|
int occurrenceId |
The ID of the occurrence or booking to get staff members for. |
|
bool includeClasses |
If true, includes the staff members assigned to any of the occurrence's classes |
|
bool includeOccurrence |
If true, includes the staff members assigned to any of the client's enrolments and, if the staff type is specified, the staff member is assigned to the occurrence with that staff type |
|
string staffType |
Optional string of the staff type to consider. If this is specified, only staff members assigned to the occurrence with this type are considered. A list of valid staff types can be obtained by calling GetStaffTypes. Pass an empty or null string to ignore staff type |
TAuthClieStaffLinksList containing the staff members that are associated with this occurrence and match the criteria
|
Copyright (c) VETtrak 2022. All rights reserved.
|
