|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.GetEnrolledTasksForEnrolment Method
|
ASP.NET VETtrak API web services
|
|
|
Retrieves a list of enrolled tasks for an enrolment.
[WebMethod(Description = "Retrieves a list of task enrolments for an enrolment")] public TAuthTaskEnrolmentList GetEnrolledTasksForEnrolment(string token, int enrolmentId);
|
Parameters |
Description |
|
string token |
String containing a token. |
|
int enrolmentId |
Integer ID of the enrolment to retrieve enrolled tasks for |
TAuthTaskEnrolmentList containing a list of enrolled tasks for the enrolment
This function retrieves a list of enrolled tasks for a single enrolment. An enrolled task consists of the task itself, as well as any result of the task.
The enrolmentId parameter is the ID of the enrolment to retrieve enrolled tasks for. Note that it is possible to pass an occurrence ID instead - in this case, the fields for client and completion in each TTaskEnrolment will be empty.
Each enrolled task is represented by a TTaskEnrolment object. The list of enrolled tasks is in the returned TAuthTaskEnrolmentList object.
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 "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.
|
