Medications
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- deleteByMedicationId() : int
- Delete a medication for a student.
- patchOnMedicationId() : int
- Updates a medical medication for a student.
- post() : int
- Create a medication for a student.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/medical/medications/{medication_id}"
Methods
deleteByMedicationId()
Delete a medication for a student.
public
deleteByMedicationId(array{medication_id: int} $params) : int
Requires one of the following roles in the Education Management system:
- Nurse
Parameters
- $params : array{medication_id: int}
-
An associative array
- medication_id: Format - int32. The ID of the student's medication.
Tags
Return values
int —Success
patchOnMedicationId()
Updates a medical medication for a student.
public
patchOnMedicationId(array{medication_id: int} $params, StudentMedicationUpdate $requestBody) : int
Requires one of the following roles in the Education Management system:
- Nurse
Parameters
- $params : array{medication_id: int}
-
An associative array
- medication_id: Format - int32. >The student medication ID
- $requestBody : StudentMedicationUpdate
-
The medication changes to update
Tags
Return values
int —Success
post()
Create a medication for a student.
public
post(StudentMedicationCreate $requestBody) : int
Returns the newly created ID.
Requires one of the following roles in the Education Management system:
- Nurse
Parameters
- $requestBody : StudentMedicationCreate
-
The medication to be created for student
Tags
Return values
int —ID of the student medication just created.