Documentation

RelationshipCreate extends BaseComponent
in package

Tags
@property

"NOT_SET"|"StepParent_StepChild"|"GrGrandParent_GrGrandChild"|"Guardian_Ward"|"AuntUncle_NieceNephew"|"Grandparent_Grandchild"|"Parent_Child"|"Custodian_Student"|"Consultant_Student"|"Caretaker_Charge"|"SpousePartner_SpousePartner"|"StepSibling_StepSibling"|"ExHusband_ExWife"|"Associate_Associate"|"HalfSibling_HalfSibling"|"Husband_Wife"|"Spouse_Spouse"|"Sibling_Sibling"|"Cousin_Cousin"|"Friend_Friend" $relationship_type The nature of the relationship; modeled where left_user 'is a' relationship to this individual. Required.

Table of Contents

Properties

$comments  : string|null
$do_not_contact  : bool
$give_parental_access  : bool|null
$left_user  : int
$list_as_parent  : bool|null
$primary  : bool
$resides_with  : bool
$tuition_responsible_signer  : bool|null
$fields  : array<string|int, string>

Properties

$do_not_contact

public bool $do_not_contact

Set to true to indicate the relationship user (specified by left_user) should not be contacted.

$give_parental_access

public bool|null $give_parental_access

Toggles 'Give Parental Access' option.

$left_user

public int $left_user

ID of the other individual in the relationship with this person

$list_as_parent

public bool|null $list_as_parent

Toggles 'List as a Parent' option.

$primary

public bool $primary

Set to true if the relationship user (specified by left_user) is the primary contact.

$resides_with

public bool $resides_with

Set to true if the child user resides with the parent user.

$tuition_responsible_signer

public bool|null $tuition_responsible_signer

Toggles 'Responsible for Signing Contract' option.

$fields

protected static array<string|int, string> $fields = ["relationship_type" => "string", "give_parental_access" => "bool", "list_as_parent" => "bool", "tuition_responsible_signer" => "bool", "left_user" => "int", "resides_with" => "bool", "do_not_contact" => "bool", "primary" => "bool", "comments" => "string"] 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results