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

Reserves a Employer's place in a Web Occurrence. 

A Employer Web Reservation is created which links the Web Employer to the Occurrence. 

A reservation is a type of web enrolment. The Employer Web Reservation can be retrieved, updated, deleted, and have employees added to it, like a normal employer web enrolment, except that it is not yet available for processing by a VETtrak user. To "complete" the reservation and turn it into a normal employer web enrolment and make it available for processing in VETtrak, use the CompleteWebReservation function. Using a web reservation also allows the user to configure individual occurrences to automatically process web reservations made into them, which will occur when CompleteWebReservation is called. 

A Web Occurrence ID (iOccu_ID) is passed as a parameter. To be valid, a Web Occurrence ID must :

  • be a published Occurrence,
  • have at least one vacancy,
 

Details of the Web Employer (sName and sIdentifier) are supplied as parameters. sIdentifier is the VETtrak Employer Identifier which may or may not be known. Anything entered in this parameter is used by a VETtrak administrator to attempt to match this Employer with existing VETtrak Employers. The parameter, sName, must be non-empty. 

This function is used to create a web reservation by a company or an employer. Employees are added to this reservation using AddWebEmployee

If a person is to be enrolled as an individual client reservation, don't use this function. Instead, use AddClientWebReservation

Web reservations added by this function can be viewed in the Reservations tab under the occurrence in the Process Web Enrolments manager in VETtrak. The user can delete them if they so choose. 

A token is passed for authentication. If the authentication fails, or other errors occur, no web enrolment is created. The result of the authentication is represented by a TAuthenticate object. 

Requires a valid registration key entry for the Bookings 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 = "Reserves an employer with the specified details into the specified occurrence ID. Employees could then be added to this web reservation")]
public TAuthID AddEmployerWebReservation(string sToken, int iOccu_ID, string sName, string sIdentifier, string sDescription, int? referralId);
Parameters 
Description 
string sToken 
String Token. 
int iOccu_ID 
Integer ID of Web Occurrence. 
string sName 
String containing the Employer's Name. Maximum length 100 characters. 
string sIdentifier 
String containing the Employer's suspected VETtrak Identifier. If unknown, enter an empty string. Maximum length 10 characters. 
string sDescription 
String - description or notes for Web Enrolment. 
int? referralId 
Integer - ID of referral source for this enrolment. Call GetReferralSources to get a list of referral sources that can be used. Specify null or 0 for no referral source 

TAuthID : an Authenticated ID object. The ID property holds the ID of the Web Enrolment. If errors occur, and the Web Enrolment if not created, the ID property holds the value BAD_ID = -1.

Copyright (c) VETtrak 2022. All rights reserved.