Documentation

Allergies extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

getByUserId()  : array<string|int, StudentAllergiesView>
Returns the medical allergies for a student.

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/school/v1/medical/users/{user_id}/allergies"

Endpoint URL pattern

Methods

getByUserId()

Returns the medical allergies for a student.

public getByUserId(array{user_id: int} $params) : array<string|int, StudentAllergiesView>

Requires at least one of the following roles in the Education Management system:

  • Nurse
Parameters
$params : array{user_id: int}

An associative array

  • user_id: Format - int32. ID of the student
Tags
throws
ArgumentException

if required parameters are not defined

Return values
array<string|int, StudentAllergiesView>

Success


        
On this page

Search results