Name 

Description 

 

Addr 

WARNING: This field is deprecated and will be removed from a future version of the API. Use UsualAddress.Building, UsualAddress.UnitDetails, UsualAddress.StreetNumber and UsualAddress.StreetName instead. This field is just a concatenation of those fields.
Address of Web Client.  

 

City 

WARNING: This field is deprecated and will be removed from a future version of the API. Use UsualAddress.City instead. This field is a copy of UsualAddress.City.
City of Web Client.  

 

Code 

Code of Web Client. 

 

DivisionId 

ID of the division the client will be assigned to. Null means the client will be linked to the occurrence's division, or the Root Division if there is no occurrence.  

 

DOB 

Web Client's Date of Birth. 

 

Email 

Email Address of Web Client. 

 

EmergencyMobile 

Mobile number of Emergency Contact for a Web Client. 

 

EmergencyName 

Emergency Contact Name for a Web Client. 

 

EmergencyPhone 

Emergency Phone for a Web Client. 

 

Gender 

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.

 

 

Given 

Given Name of Web Client. 

 

HomePhone 

Home Phone Number of Web Client. 

 

Mobile 

Mobile Number of Web Client. 

 

Other 

Other Name of Web Client. 

 

PCode 

WARNING: This field is deprecated and will be removed from a future version of the API. Use UsualAddress.Postcode instead. This field is a copy of UsualAddress.Postcode.
Post Code of Web Client.  

 

PostalAddr 

WARNING: This field is deprecated and will be removed from a future version of the API. Use PostalAddress.Building, PostalAddress.UnitDetails, PostalAddress.StreetNumber, PostalAddress.StreetName and PostalAddress.POBox instead. This field is just a concatenation of those fields.
Postal address of Web Client.  

 

PostalAddress 

The full postal address of the web client. This is a TAddress object.  

 

PostalCity 

WARNING: This field is deprecated and will be removed from a future version of the API. Use PostalAddress.City instead. This field is a copy of PostalAddress.City.
Postal city/suburb of Web Client.  

 

PostalPostcode 

WARNING: This field is deprecated and will be removed from a future version of the API. Use PostalAddress.Postcode instead. This field is a copy of PostalAddress.Postcode.
Postal Post Code of Web Client.  

 

PostalStat_ShortName 

WARNING: This field is deprecated and will be removed from a future version of the API. Use PostalAddress.State instead. This field is a copy of PostalAddress.State.
Postal State ShortName of Web Client.
Valid Short Names are (see GetStateList):
NSW, Vic, Qld, SA, WA, Tas, NT, ACT, Other, Overseas.  

 

Stat_ShortName 

WARNING: This field is deprecated and will be removed from a future version of the API. Use UsualAddress.State instead. This field is a copy of UsualAddress.State.
State ShortName of Web Client.
Valid Short Names are (see GetStateList):
NSW, Vic, Qld, SA, WA, Tas, NT, ACT, Other, Overseas.  

 

Surname 

Surname of Web Client. 

 

SurveyContactStatusCode 

The survey contact status code of the web client. Valid values are:

• A : Available for survey use
• C : Correctional facility (address or enrolment)
• D : Deceased student
• E : Excluded
• I : Invalid address / Itinerant student (very low likelihood of response)
• M : Minor - under age of 15 (not to be surveyed)
• O : Overseas (address or enrolment)

 

 

Title 

Title of Web Client. 

 

USI 

The Unique Student Identifier for 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.  

 

UsualAddress 

The full usual/residential address of the web client. This is a TAddress object.  

 

Webe_ID 

ID of Web Enrolment. 

 

Wecl_ID 

ID of Web Client. 

 

Weco_ID 

ID of Web Company. 

 

WorkPhone 

Work Phone Number of Web Client.