ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.CompleteWebReservation Method

Converts a client or employer web reservation into a real web enrolment, which is able to be processed in VETtrak. May also automatically process the web enrolment if the occurrence is configured to do so. 

The webEnrolId must be an ID returned from the AddClientWebReservation or AddEmployerWebReservation function. 

If the occurrence is configured in VETtrak to automatically process web reservations made into it, this will also automatically process the web enrolment. This performs the same functionality as the ProcessWebEnrolment function, with updateMatches on. In this case, the returned TAuthCompleteWebReservation will indicate WasAutoProcessed = true, and the ProcessedWebEnrol field will contain a TProcessedWebEnrol object with details of the automatically-processed web enrolment. 

A token is passed for authentication. If the authentication fails, or other errors occur, no web enrolment is created or processed. 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.

C#
[WebMethod(Description = "Completes a client or employer reservation to make it available for processing, and automatically processes it if the occurrence is configured to do so")]
public TAuthCompleteWebReservation CompleteWebReservation(string token, int webEnrolId);
Parameters 
Description 
string token 
String Token. 
int webEnrolId 
Integer ID of Web Reservation. 

TAuthCompleteWebReservation : indicates whether the update was successful and, if the web enrolment was automatically processed, details of the processed web enrolment.

Copyright (c) VETtrak 2022. All rights reserved.