Documentation

CandidateRead extends BaseComponent
in package

Candidate Read

Tags
@property

?\Blackbaud\SKY\School\Components\CandidateEventReadModel[] $events An array of candidate event objects

@property

?\Blackbaud\SKY\School\Components\CandidateInterviewReadModel[] $interviews An array of candidate interview objects

@property

?\Blackbaud\SKY\School\Components\CandidateVisitReadModel[] $visits An array of candidate visit objects

Table of Contents

Properties

$admissions_staff  : string|null
$admissions_staff_id  : int|null
$application  : ApplicationModel
$boarding_or_day  : string|null
$comment  : string|null
$created  : string|null
$created_by  : string|null
$current_status  : string|null
$current_status_date  : string|null
$decision  : SchoolDecisionModel
$email  : string|null
$entering_grade  : string|null
$entering_grade_id  : int|null
$entering_year  : string|null
$entering_year_id  : int|null
$ethnicity  : string|null
$family_id  : int|null
$financial_aid  : bool|null
$first_name  : string|null
$gender  : string|null
$has_504  : bool|null
$has_iep  : bool|null
$inquiry_source  : string|null
$inquiry_source_id  : int|null
$international  : bool|null
$last_name  : string|null
$middle_name  : string|null
$modified  : string|null
$modified_by  : string|null
$nickname  : string|null
$parent1_email  : string|null
$parent2_email  : string|null
$preferred_name  : string|null
$prefix  : string|null
$referral_type  : string|null
$referral_type_id  : int|null
$role  : string|null
$role_id  : int|null
$school_program  : string|null
$status_id  : int|null
$suffix  : string|null
$user_id  : int|null
$fields  : array<string|int, string>

Properties

$current_status

public string|null $current_status

Text representation of their current enrollment status

$current_status_date

public string|null $current_status_date

Current status date

$entering_grade

public string|null $entering_grade

Text representation of the grade candidate will be joining

$entering_grade_id

public int|null $entering_grade_id

Identifier for the grade candidate will be joining

$entering_year

public string|null $entering_year

Text representation of the school year the candidate will be joining

$entering_year_id

public int|null $entering_year_id

Identifier for the school year the candidate will be joining

$first_name

public string|null $first_name

Candidates first name

$last_name

public string|null $last_name

Candidates last name

$middle_name

public string|null $middle_name

Candidates middle name

$nickname

public string|null $nickname

Candidates nick name (if available)

$parent1_email

public string|null $parent1_email

1st Email of candidates parent

$parent2_email

public string|null $parent2_email

2nd email of candidates parent

$status_id

public int|null $status_id

Identifier for their enrollment status

$user_id

public int|null $user_id

Unique Identifer for this candidate

$fields

protected static array<string|int, string> $fields = ["user_id" => "int", "first_name" => "string", "last_name" => "string", "middle_name" => "string", "prefix" => "string", "suffix" => "string", "nickname" => "string", "role" => "string", "role_id" => "int", "current_status" => "string", "status_id" => "int", "entering_year" => "string", "entering_year_id" => "int", "entering_grade" => "string", "entering_grade_id" => "int", "email" => "string", "comment" => "string", "parent1_email" => "string", "parent2_email" => "string", "international" => "bool", "school_program" => "string", "gender" => "string", "ethnicity" => "string", "boarding_or_day" => "string", "financial_aid" => "bool", "admissions_staff_id" => "int", "admissions_staff" => "string", "inquiry_source" => "string", "inquiry_source_id" => "int", "referral_type" => "string", "referral_type_id" => "int", "has_iep" => "bool", "has_504" => "bool", "created_by" => "string", "created" => "string", "modified_by" => "string", "modified" => "string", "preferred_name" => "string", "decision" => "\\Blackbaud\\SKY\\School\\Components\\SchoolDecisionModel", "family_id" => "int", "current_status_date" => "string", "application" => "\\Blackbaud\\SKY\\School\\Components\\ApplicationModel", "events" => "\\Blackbaud\\SKY\\School\\Components\\CandidateEventReadModel[]", "interviews" => "\\Blackbaud\\SKY\\School\\Components\\CandidateInterviewReadModel[]", "visits" => "\\Blackbaud\\SKY\\School\\Components\\CandidateVisitReadModel[]"]

        
On this page

Search results