Specifications‎ > ‎

Family data

liss.publishFamilies()

The term 'family' in LISS is called 'household' by some SIS's, for example 1 or 2 parents grouped by address.

Call:

liss.publishFamilies(auth : authenticationObject, data : array of structs)

Parameters:

auth : See section 3.3

Returns:

An array of structs.  Each struct is defined as follows:

 Field  Type  Notes  Example
 Code  string (mandatory) A short identifier which uniquely identifies this family.

SMITH041
 Name string  LISS does not give much guidance on how this field is to be used, but it could be something that you can put at the top of a letter sent to the parents.  Mr & Mrs Smith

Jenny & John Smith
 Email  string One email address which will reach one or both parents  jenny.smith@gmail.com
 Phone  string Phone number, mobile and/or landline.  0488 888 888
 Address  string
 31 Denfort Rd, Liquorland 2251
Children   array of structs Array of structs defined below.  

Each item in the 'Children' array is defined as follows:
 Field  Type  Notes  Example
 Code  string (mandatory) A short identifier which uniquely identifies this student.

SMI51235
 FirstName string  The child's first name.Kenny
 Surname  string Student's surname  Smith
 Custodial  string Phone number, mobile and/or landline.  0488 888 888
 Email  string The student's emailstudentSMI51235@denfort.edu.au


 



liss.getFamilies()

Call:

liss.getFamilies(auth : authenticationObject)

Parameters:

auth : See section 3.3

Returns:

An array of structs.  Each struct is defined as above (liss.publishFamilies()).