Conditions
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- deleteByConditionId() : int
- Delete a medical condition for a student.
- patchOnConditionId() : int
- Update a medical condition for a student.
- post() : int
- Creates a condition for a student.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/medical/conditions/{condition_id}"
Methods
deleteByConditionId()
Delete a medical condition for a student.
public
deleteByConditionId(array{condition_id: int} $params) : int
Requires one of the following roles in the Education Management system:
- Nurse
Parameters
- $params : array{condition_id: int}
-
An associative array
- condition_id: Format - int32. The ID of the student's condition.
Tags
Return values
int —Success
patchOnConditionId()
Update a medical condition for a student.
public
patchOnConditionId(array{condition_id: int} $params, StudentConditionUpdate $requestBody) : int
Requires one of the following roles in the Education Management system:
- Nurse
Parameters
- $params : array{condition_id: int}
-
An associative array
- condition_id: Format - int32. The ID of the student's condition.
- $requestBody : StudentConditionUpdate
-
The condition changes
Tags
Return values
int —Success
post()
Creates a condition for a student.
public
post(StudentMedicalCondition $requestBody) : int
Returns the newly created ID.
Requires one of the following roles in the Education Management system:
- Nurse
Parameters
- $requestBody : StudentMedicalCondition
-
The medical condition to be created for student
Tags
Return values
int —ID of the student medical condition just created.