|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.GetEnrolledTasksForOccurrence Method
|
ASP.NET VETtrak API web services
|
|
|
Retrieves a list of enrolled tasks from all enrolments within an occurrence or booking.
[WebMethod(Description = "Retrieves a list of enrolled tasks for all enrolments in an occurrence")] public TAuthTaskEnrolmentList GetEnrolledTasksForOccurrence(string token, int occurrenceId, bool activeEnrolmentsOnly);
|
Parameters |
Description |
|
string token |
String containing a token. |
|
int occurrenceId |
Integer ID of the occurrence to retrieve enrolled tasks for. |
|
bool activeEnrolmentsOnly |
Indicates whether to only return enrolled tasks that are linked to active enrolments. Valid values are:
|
TAuthTaskEnrolmentList containing the list of enrolled tasks from the occurrence's enrolments
This function retrieves a list of all enrolled tasks from all client or employee enrolments in a single occurrence. Enrolled tasks include results.
The occurrenceId parameter is the ID of the occurrence to retrieve enrolled tasks for.
The activeEnrolmentsOnly parameter is a flag to indicate whether only active enrolments should be considered. If false, enrolled tasks from all the occurrence's enrolments are retrieved. If true, only enrolled tasks from the occurrence's currently active enrolments are retrieved.
Each enrolled task is represented by a TTaskEnrolment object. The list of enrolled tasks is in the returned TAuthTaskEnrolmentList object.
Use the UpdateEnrolledTask function to update the result of a single enrolled task returned by this function.
A token is passed for authentication. If the authentication fails, or other errors occur, no enrolled tasks are returned. The result of the authentication is represented by a TAuthenticate object.
Requires a valid registration key entry for the Tasks 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.
|
