Documentation

Results extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

getByClassIdAndStudentId()  : ResultsOutputModelSvc
Returns a collection of results for a specified ```class\_id``` and ```student\_id```.

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/students/{student_id}/results"

Endpoint URL pattern

Methods

getByClassIdAndStudentId()

Returns a collection of results for a specified ```class\_id``` and ```student\_id```.

public getByClassIdAndStudentId(array{class_id: string, student_id: string} $params) : ResultsOutputModelSvc
Parameters
$params : array{class_id: string, student_id: string}

An associative array

  • class_id: sourcedId for the class
  • student_id: sourcedId for the student
Tags
throws
ArgumentException

if required parameters are not defined

Return values
ResultsOutputModelSvc

OK - It was possible to read the resource.


        
On this page

Search results