Documentation

RelationshipRead extends BaseComponent
in package

RelationshipRead Model

Table of Contents

Properties

$comment  : string|null
$contact  : bool
$first_name  : string|null
$id  : string|null
$last_name  : string|null
$list_as_parent  : bool
$parental_access  : bool
$primary  : bool
$relationship  : int|null
$resides_with  : bool
$show_parent  : bool
$tuition_responsible_signer  : bool
$type_id  : int|null
$user_one_id  : int|null
$user_one_role  : string|null
$user_two_id  : int|null
$fields  : array<string|int, string>

Properties

$comment

public string|null $comment

A comment describing the relationship

$contact

public bool $contact

Returns True if the user can be contacted. Returns False if the user is marked as 'No Contact' in the UI.

$first_name

public string|null $first_name

The first name of the user(s) associated with the queried user

$last_name

public string|null $last_name

The last name of the user(s) associated with the queried user

$list_as_parent

public bool $list_as_parent

Returns True if List as Parent is enabled in the UI for a user. If enabled, the user can be listed in directories as the student's parent

$parental_access

public bool $parental_access

Returns True if Parental Access is enabled in the UI for a relationship type

$primary

public bool $primary

Returns True if the user in a relationship is the primary user

$relationship

public int|null $relationship

The enum value that describes the relationship (ex. Parent_Child = 6)

$resides_with

public bool $resides_with

Returns True if Resides With is enabled in the UI. If enabled, then the user in a relationship resides with the queried user

$show_parent

public bool $show_parent

Returns True if a parent's contact information is displayable in the directory

$tuition_responsible_signer

public bool $tuition_responsible_signer

Returns True if Responsible Signer is enabled in the UI for a user. If enabled, it indicates the user signs enrollment contracts in onBoard

$type_id

public int|null $type_id

The ID of the relationship type. The ID corresponds with static options in the UI

$user_one_id

public int|null $user_one_id

The ID of the user associated with user_two_id

$user_one_role

public string|null $user_one_role

The role of the user being queried

$user_two_id

public int|null $user_two_id

The ID of the user associated with user_one_id

$fields

protected static array<string|int, string> $fields = ["id" => "string", "comment" => "string", "contact" => "bool", "first_name" => "string", "last_name" => "string", "list_as_parent" => "bool", "parental_access" => "bool", "primary" => "bool", "relationship" => "int", "resides_with" => "bool", "show_parent" => "bool", "tuition_responsible_signer" => "bool", "type_id" => "int", "user_one_id" => "int", "user_one_role" => "string", "user_two_id" => "int"] 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results