Extension 3 Family data

Ext 3.1 Publish families

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, data)

Parameters

auth: See authentication

data: 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	The family's address.	31 Denfort Rd, Liquorland 2251
Guid	32 char hexadecimal string	32 hexadecimal characters. They might be uppercase or lowercase, but we require that they do not contain punctuation.	EF6E5950ED748E5A9D4997A8B7337099
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 student'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 email.	studentSMI51235@denfort.edu.au

Returns

Nothing - an empty string "". If anything other than an error is returned it should be ignored. For error reporting see fault codes.

Example

Send

{
    "method": "liss.publishFamilies",
    "params": [
        {
            "School": "03014",
            "UserName": "Jsmith",
            "Password": "Password1",
            "LissVersion": 10002,
            "UserAgent": "Edval"
        },
        [
            {
                "Code": "SMITH041",
                "Name": "Mr & Mrs Smith",
                "Email": "jenny.smith@gmail.com",
                "Phone": "0488 888 888",
                "Address": "31 Denfort Rd, Liquorland 2251",
                "Guid": "EF6E5950ED748E5A9D4997A8B7337099",
                "Children": [
                    {
                        "Code": "SMI51235",
                        "FirstName": "Kenny",
                        "Surname": "Smith",
                        "Custodial": "0488 888 888",
                        "Email": "studentSMI51235@denfort.edu.au"
                    }
                ]
            }
        ]
    ],
    "id": 0
}

Return

{
    "result": "",
    "id": 0
}

Ext 3.2 Get families

Call

liss.getFamilies(auth)

Parameters

auth: See authentication

Returns

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

Example

Send

{
    "method": "liss.publishFamilies",
    "params": [
        {
            "School": "03014",
            "UserName": "Jsmith",
            "Password": "Password1",
            "LissVersion": 10002,
            "UserAgent": "Edval"
        }
    ],
    "id": 0
}

Return

{
    "result": [
        {
            "Code": "SMITH041",
            "Name": "Mr & Mrs Smith",
            "Email": "jenny.smith@gmail.com",
            "Phone": "0488 888 888",
            "Address": "31 Denfort Rd, Liquorland 2251",
            "Guid": "EF6E5950ED748E5A9D4997A8B7337099",
            "Children": [
                {
                    "Code": "SMI51235",
                    "FirstName": "Kenny",
                    "Surname": "Smith",
                    "Custodial": "0488 888 888",
                    "Email": "studentSMI51235@denfort.edu.au"
                }
            ]
        }
    ],
    "id": 0
}