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

Enrol an Employer in a Web Occurrence. 

An Employer Web Enrolment is created which links the Web Employer to the Occurrence. 

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,
 

Previous to version 4.3.6, a valid web occurrence could not have started before today. That condition has been dropped, so that it is now possible to enrol in any valid web occurrence, regardless of its start or end dates. 

The web developer can re-impose the previous restriction, if desired, according to business rules. 

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 enrolment by a company or an employer. Employees are added to this enrolment using AddWebEmployee

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

Web enrolments added by this function are available in the Employer tab under the occurrence in the Process Web Enrolments manager in VETtrak, so that they can be processed, possibly matched with an existing employer (with or without updating the existing employer), any employees created, matched or updated, and turned into full enrolments. Alternatively, they can be processed automatically by calling the ProcessWebEnrolment function. 

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 = "Enrols an employer with the specified details into a new web enrolment linked to the specified occurrence ID. Employees could then be added to this web enrolment")]
public TAuthID AddEmployerWebEnrolment(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.