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

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

An 'Loose' Employer must have previously been created, see AddLooseWebEmployer. This function records Employer details for the given Web Employer ID. 

A Web Employer ID (webEmployerId) is passed as a parameter. This should be the ID returned by the AddLooseWebEmployer function. 

The function GetLooseWebEmployer can be used to retrieve the details that are updated by this function. 

This function should not be used to update details of employers who are enrolled via an Employer Web Enrolment. If these cases, use UpdateWebEmployer

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 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 = "Records the specified additional data against a loose employer")]
public TAuthenticate UpdateLooseWebEmployer(string token, int webEmployerId, string businessAddr, string businessCity, string businessPostcode, string businessState, string phone, string postalAddr, string postalCity, string postalPostcode, string postalState, TAddress businessAddress, TAddress postalAddress);
Parameters 
Description 
string token 
String containing a token. 
int webEmployerId 
Integer ID of Loose Web Employer. 
string businessAddr 
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 businessCity 
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 businessPostcode 
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 businessState 
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 phone 
String - Phone Number of Employer. Maximum length 20 characters. 
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 postalPostcode 
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 postalState 
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. 

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

 

Copyright (c) VETtrak 2022. All rights reserved.