ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
TClieDetail Members

The following tables list the members exposed by TClieDetail.

 
Name 
Description 
 
 
 
Name 
Description 
 
Client's Address Type.
Valid Address Types are:
  • Clie_Address_Type = 0 ..... Normal
  • Clie_Address_Type = 1 ..... International
 
 
Client Code. This is a unique code, and is used to identify the client when reporting. Maximum length 10 characters. 
 
Client's primary employment Commencement Date. 
 
Client's primary employment Last Assessed Date. 
 
Client's Date of Birth. 
 
Email Address of Client. Maximum length 100 characters. 
 
Emergency Contact Name for Client. Maximum length 100 characters. 
 
Phone Number for Client's Emergency Contact. Maximum length 20 characters. 
 
Fax/Phone Number of Client. For AVETMISS compliance, this should include the area code (thus, contain at least 10 digits). Maximum length 20 characters. 
 
Given Name of Client. Maximum length 50 characters. 
 
Home Phone Number of Client. For AVETMISS compliance, this should include the area code (thus, contain at least 10 digits). Maximum length 20 characters. 
 
Mobile Phone Number of Client. For AVETMISS compliance, this should contain at least 10 digits. Maximum length 20 characters. 
 
Other Name for Client. Maximum length 50 characters. 
 
Postal Address for Client. Maximum length 170 characters.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format fields at the bottom of the address page in the Personal Wizard are in PostalAddress.UnitDetails, PostalAddress.Building, PostalAddress.StreetNumber, PostalAddress.StreetName and PostalAddress.POBox.
You should use the PostalAddress fields in preference to this field. This field may be removed in a future API version.  
 
Passport number for Client. Maximum length 50 characters. 
 
City of Client's Postal Address. Maximum length 50 characters.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format field at the bottom of the address page in the Personal Wizard is in PostalAddress.City.
If you update this field, the PostalAddress.City field will be automatically updated as well.
You should use the PostalAddress.City field in preference to this field. This field may be removed in a future API version.  
 
Post Code of Client's Postal Address. Maximum length 4 characters.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format field at the bottom of the address page in the Personal Wizard is in PostalAddress.Postcode.
You should use the PostalAddress.Postcode field in preference to this field. This field may be removed in a future API version.  
 
Street Address of Client's Residence. Maximum length 170 characters.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format fields at the bottom of the address page in the Personal Wizard are in UsualAddress.UnitDetails, UsualAddress.Building, UsualAddress.StreetNumber and UsualAddress.StreetName.
You should use the UsualAddress fields in preference to this field. This field may be removed in a future API version.  
 
City of Client's Residence. Maximum length 50 characters.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format field at the bottom of the address page in the Personal Wizard is in UsualAddress.City.
You should use the UsualAddress.City field in preference to this field. This field may be removed in a future API version.  
 
Post Code of Client's Residence. Maximum length 4 characters.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format field at the bottom of the address page in the Personal Wizard is in UsualAddress.Postcode.
You should use the UsualAddress.Postcode field in preference to this field. This field may be removed in a future API version.  
 
Client's primary employment salary 
 
Surname of Client. Maximum length 50 characters. 
 
Title for Client. This is a short title like "Mr", "Mrs", "Ms", "Miss", "Dr" etc. Maximum length 10 characters. 
 
Username for Client. Maximum length 50 characters. 
 
Visa number for Client. Maximum length 50 characters. 
 
Client's Visa expiry date. 
 
Work Phone Number of Client. For AVETMISS compliance, this should include the area code (thus, contain at least 10 digits). Maximum length 20 characters. 
 
The ID of the division the client belongs to 
 
Identifier for Client's Employer. 
 
Gender of Client.
Valid Gender Values are:
  • Not Stated ......... Clie_Gender = @,
  • Male ............... Clie_Gender = M,
  • Female ............. Clie_Gender = F,
  • Indeterminate/Intersex/Unspecified .... Clie_Gender = X.
 
 
Code of primary employment position held by Client. If specified, must be a valid position code, see GetPositions. New positions can be added using AddPosition. Maximum length 10 characters. 
 
Name of primary employment position held by Client. If specified, must be a valid position name, see GetPositions. New positions can be added using AddPosition. Maximum length 100 characters. 
 
The full postal address of the client in AVETMISS 7 format, shown at the bottom of the address page in the Personal Wizard. This is a TAddress object.
If the client has only an AVETMISS 6 address but not an AVETMISS 7 address, this field will still be populated with the AVETMISS 6 address split into parts.  
 
State Short Name of Client's Postal Address.
Valid Short Names are (see GetStateList):
NSW, Vic, Qld, SA, WA, Tas, NT, ACT, Other, Overseas.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format field at the bottom of the address page in the Personal Wizard is in PostalAddress.State.
You should use the PostalAddress.State field in preference to this field. This field may be removed in a future API version.  
 
State Short Name of Client's Residence.
Valid Short Names are (see GetStateList):
NSW, Vic, Qld, SA, WA, Tas, NT, ACT, Other, Overseas.
This is the AVETMISS 6 format field, shown at the top of the address page in the Personal Wizard. The corresponding AVETMISS 7 format field at the bottom of the address page in the Personal Wizard is in UsualAddress.State.
You should use the UsualAddress.State field in preference to this field. This field may be removed in a future API version.  
 
Client's primary employment Termination Date. 
 
USI 
The Unique Student Identifier of the client.
A USI, if specified, must be 10 characters, must be upper case (allowed characters are 2-9, and A-Z except I and O), and must have a valid Luhn Mod N check character. Use the ValidateUSI function to check whether a USI is valid.  
 
Whether or not the client is exempt from the USI scheme  
 
The full usual/residential address of the client in AVETMISS 7 format, shown at the bottom of the address page in the Personal Wizard. This is a TAddress object.
If the client has only an AVETMISS 6 address but not an AVETMISS 7 address, this field will still be populated with the AVETMISS 6 address split into parts.  
 
Name of Visa Type for Client. If specified, must be a valid Visa Type name, see GetVisaTypeList. Maximum length 100 characters. 
Copyright (c) VETtrak 2022. All rights reserved.