Collapse All
ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.UpdateWebEmployer Method

Update the details of a Web Employer (aka Web Company). 

An Employer Web Enrolment must have previously been created, see AddEmployerWebEnrolment. This function records Employer details for the given Web Enrolment. 

A Web Enrolment ID (iWebe_ID) is passed as a parameter. This should be the ID returned by the AddEmployerWebEnrolment function. 

It is not possible to change the Employer's fundamental data which was used to create the enrolment. If it is necessary to change either the company name or Identifier, then it will be necessary to delete the enrolment and start again. 

This function should not be used to update details of clients who are enrolled via a Client Web Enrolment. If these cases, use UpdateWebClient. 

A token is passed for authentication. If the authentication fails, or other errors occur, nothing is updated . 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 = "Records the specified additional data against the employer linked to the specified web enrolment ID")]
public TAuthenticate UpdateWebEmployer(string sToken, int iWebe_ID, string sAddr, string sCity, string sPCode, string sShortState, string sPhone, int iExpected, string postalAddr, string postalCity, string postalPCode, string postalShortState, TAddress businessAddress, TAddress postalAddress);
Parameters
Parameters 
Description 
string sToken 
String containing a token. 
int iWebe_ID 
Integer ID of Web Enrolment. 
string sAddr 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use businessAddress.Building, businessAddress.UnitDetails, businessAddress.StreetNumber and businessAddress.StreetName instead.
String - Business Address for Employer. Maximum length 170 characters. 
string sCity 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use businessAddress.City instead.
String - City of Employer's Business Address. Maximum length 50 characters. 
string sPCode 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use businessAddress.Postcode instead.
String - Post Code of Employer's Business Address. Maximum length 4 characters. 
string sShortState 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use businessAddress.State instead.
String - State Short Name for Employer's Business Address. See GetStateList.
Valid Short Names are:
  • NSW,
  • Vic,
  • Qld,
  • SA,
  • WA,
  • Tas,
  • NT,
  • ACT,
  • Other,
  • Overseas. 
string sPhone 
String - Phone Number of Employer. Maximum length 20 characters. 
int iExpected 
Integer - The number of people, from the Employer, expected to attend the training. 
string postalAddr 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use postalAddress.Building, postalAddress.UnitDetails, postalAddress.StreetNumber, postalAddress.StreetName and postalAddress.POBox instead.
String - Postal Address for Employer. Maximum length 170 characters. 
string postalCity 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use postalAddress.City instead.
String - City of Employer's Postal Address. Maximum length 50 characters. 
string postalPCode 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use postalAddress.Postcode instead.
String - Post Code of Employer's Postal Address. Maximum length 4 characters. 
string postalShortState 
WARNING: This field is deprecated and will be removed in a future version of the API. You should use postalAddress.State instead.
String - State Short Name for Employer's Postal Address. See GetStateList.
Valid Short Names are:
  • NSW,
  • Vic,
  • Qld,
  • SA,
  • WA,
  • Tas,
  • NT,
  • ACT,
  • Other,
  • Overseas. 
TAddress businessAddress 
TAddress : The business address of the employer. This is the preferred way to specify the address. If this object is specified, the sAddr, sCity, sPCode and sShortState fields will be ignored. 
TAddress postalAddress 
TAddress : The postal address of the employer. This is the preferred way to specify the address. If this object is specified, the postalAddr, postalCity, postalPCode and postalShortState fields will be ignored. 
Returns

TAuthenticate : an Authenticate Object containing the result of the update.

Description

 

Group
Copyright (c) VETtrak 2022. All rights reserved.

Made with Doc-O-Matic® Express

Doc-O-Matic