|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.UpdateEnrolment Method
|
ASP.NET VETtrak API web services
|
|
|
Updates enrolment parameters, specifically the enrolment status, date of effect, start date, finish date and/or enrolment type.
All parameters are optional - pass a null value to ignore updating that parameter. If the enrolmentType parameter is passed as an empty string, i.e. "", then the enrolment type will be cleared.
A token is passed for authentication. If the authentication fails, or other errors occur, the enrolment wont be updated. 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 "Protected", and can only be accessed by users that have explicitly been granted permission to the API.
[WebMethod(Description = "Updates certain parameters on an enrolment")] public TAuthenticate UpdateEnrolment(string token, int enrolmentId, string enrolmentStatus, DateTime? dateOfEffect, DateTime? startDate, DateTime? finishDate, string enrolmentType);
|
Parameters |
Description |
|
string token |
String containing a token. |
|
int enrolmentId |
Integer ID of the enrolment to update. |
|
string enrolmentStatus |
Optional string, a valid Enrolment Status name. |
|
DateTime? dateOfEffect |
Optional Nullable DateTime, the date of the status change. If no date of effect is passed and an enrolment status is passed then the date of effect will be today's date. |
|
DateTime? startDate |
Optional Nullable DateTime, start date of the enrolment. |
|
DateTime? finishDate |
Optional Nullable DateTime, finish date of enrolment. |
|
string enrolmentType |
Optional string, a valid Enrolment Type, or an empty string to have the value cleared on the enrolment. |
TAuthenticate : a TAuthenticate Object containing the result of the update.
|
Copyright (c) VETtrak 2022. All rights reserved.
|
