Candidates
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : CandidateReadCollection
- Returns a collection of admissions candidates.
- post() : int
- Creates a new admissions candidate record.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/admissions/candidates"
Endpoint URL pattern
Methods
list_()
Returns a collection of admissions candidates.
public
list_(array<string|int, mixed> $params) : CandidateReadCollection
Requires one of the following roles in the Education Management system:
-
Admissions Manager
-
Platform Manager
-
SKY API Data Sync
NOTE: The following fields have been deprecated and are no longer returned as of 01/01/2023. - school_decision
-
school_decision_type
-
candidate_decision
-
candidate_decision_type
Use the school decision and candidate decision objects instead.
NOTE: The filter for school_year_id has been replaced by school_year.
The school_year_id filter has been deprecated and no longer functions as of 01/01/2023.
Parameters
- $params : array<string|int, mixed>
Tags
Return values
CandidateReadCollection —Success
post()
Creates a new admissions candidate record.
public
post(CandidateCreate $requestBody) : int
Returns the ID of the newly created candidate.
Requires one of the following roles in the Education Management system:
-
Admissions Manager
-
Admissions Staff
Parameters
- $requestBody : CandidateCreate
Tags
Return values
int —Success