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

Update the AVETMISS details of a Web Client. 

A Client Web Enrolment must have previously been created, see AddClientWebEnrolment. This function records AVETMISS details for the Client in the given Web Enrolment. Any existing AVETMISS details for the Web Client are replaced. 

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

This function should not be used to update details of clients who are part of an Employer Web Enrolment. In these cases, use UpdateWebEmployeeAVETMISS. 

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 AVETMISS data against the client linked to the specified web enrolment ID")]
public TAuthenticate UpdateWebClientAVETMISS(string sToken, int iWebe_ID, string sCoun_Code, string sEmca_Code, string sLang_Code, string sScle_Code, string sPriorEdFlag, string sDisabilityFlag, string sAtSchoolFlag, int iYearCompleted, string sWhereCompleted, string sProfSpokEngFlag, string sAboriginalFlag, List<TDisa> dlDisabilityList, List<TPred> plPriorEdList);
Parameters
Parameters 
Description 
string sToken 
String containing a token. 
int iWebe_ID 
Integer ID of Web Enrolment. 
string sCoun_Code 
String - Code for Country where Client was born. See GetCountryList for Valid Country Codes. 
string sEmca_Code 
String - Code for Client's Employment Category. See GetEmploymentCategoryList for Valid Employment Category Codes. 
string sLang_Code 
String - Code for Language spoken by Client at home. See GetLanguageList for Valid Language Codes. 
string sScle_Code 
String - Code for School Level attained by Client. See GetSchoolLevelList for Valid School Level Codes. 
string sPriorEdFlag 
String - Prior Education Achievement Flag.
Valid Prior Education Flags are:
  • PriorEdFlag = @ ....... Not Stated,
  • PriorEdFlag = Y ....... Yes, a prior education achievement has been successfully completed,
  • PriorEdFlag = N ....... No, a prior education achievement has NOT been successfully completed. 
string sDisabilityFlag 
String - Disability Flag.
Valid Disability Flags are:
  • DisabilityFlag = @ ....... Not Stated,
  • DisabilityFlag = Y ....... Yes, has Disability,
  • DisabilityFlag = N ....... No, does not have Disability. 
string sAtSchoolFlag 
String - At (Secondary) School Flag.
Valid At School Flags are:
  • @ => Not Stated,
  • Y => Yes,
  • N => No. 
int iYearCompleted 
Integer - Year Client's Highest School Level was attained. 
string sWhereCompleted 
String - Where Client's Highest School Level was attained. Maximum length 50 characters. 
string sProfSpokEngFlag 
String - Proficiency in Spoken English Flag.
Valid Flags are:
  • @ => Not Stated,
  • 1 => Very Well,
  • 2 => Well,
  • 3 => Not Well,
  • 4 => Not at all. 
string sAboriginalFlag 
String - Aboriginal Flag.
Valid Flags are:
  • @ => Not Stated,
  • 1 => Aboriginal,
  • 2 => Torres Strait Islander,
  • 3 => Both,
  • 4 => Neither. 
List<TDisa> dlDisabilityList 
List of TDisa - List of Disability items relating to Client. 
List<TPred> plPriorEdList 
List of TPred - List of Prior Education items relating to Client. 
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