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

Creates a 'Loose' Web Employer for further use. Returns a TAuthID that contains the new ID for the 'loose' web employer. 

There are two uses for a 'Loose' Employer: 

 

  • A 'Loose' Employer can be used as the invoicee for an invoice for a web enrolment, instead of the enrolee, by specifying the webEmployerId in a call to AddWebInvoice.
 

Note that a 'Loose' Employer can be attached as an invoicee and/or client employer to any number of web enrolments. The 'Loose' Employer will be deleted when a web enrolment is processed that references it and there are no other unprocessed web enrolments that reference it. It can also be deleted by calling DeleteLooseWebEmployer

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 = "Creates a 'Loose' employer with the specified details for further use")]
public TAuthID AddLooseWebEmployer(string token, string employerName, string employerIdentifier, string description);
Parameters 
Description 
string token 
String Token. 
string employerName 
String containing the Employer's Name. Maximum length 100 characters. 
string employerIdentifier 
String containing the Employer's suspected VETtrak Identifier. If unknown, enter an empty string. 
string description 
String - description or notes for Web Enrolment. 

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

Copyright (c) VETtrak 2022. All rights reserved.