Testscores
extends BaseEndpoint
in package
Routing class for the subnamespace `Testscores`
Tags
Table of Contents
Properties
- $all : All
- $_all : All|null
- $_testtypes : Testtypes|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- list_() : TestScoreCollection
- Returns a collection of test scores.
- postToUserId() : int
- Creates a test score for a student ```user\_id```
Properties
$all
public
All
$all
$_all
protected
All|null
$_all
= null
$_testtypes
protected
Testtypes|null
$_testtypes
= null
$_testtypes
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["testtypes" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Testscores\\Testtypes", "all" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Testscores\\All"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/testscores/{user_id}"
Methods
list_()
Returns a collection of test scores.
public
list_(array{user_id: int, size?: int, page?: int} $params) : TestScoreCollection
Requires the following role in the Education Management system:
- Grading Manager
Parameters
- $params : array{user_id: int, size?: int, page?: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- size: Format - int32. The number of records per page (Default record size is 100).
- page: Format - int32. The page of results to start from (Default start page is 1 and records per page is 100).
Tags
Return values
TestScoreCollection —Success
postToUserId()
Creates a test score for a student ```user\_id```
public
postToUserId(array{user_id: int} $params, TestScoreAdd $requestBody) : int
Requires the following role in the Education Management system:
- Grading Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- $requestBody : TestScoreAdd
Tags
Return values
int —Success