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