Results
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- deleteById() : ResultsOutputModelSvc
- Deletes the specified result sourcedId.
- get() : ResultsOutputModelSvc
- Returns a collection of results.
- getById() : ResultOutputModelSvc
- Returns a specific result.
- putById() : ResultOutputModelSvc
- Returns the result object that was created or updated.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/results/{id}"
Methods
deleteById()
Deletes the specified result sourcedId.
public
deleteById(array{id: string} $params) : ResultsOutputModelSvc
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the result
Tags
Return values
ResultsOutputModelSvc —OK - Resource has been deleted.
get()
Returns a collection of results.
public
get() : ResultsOutputModelSvc
Return values
ResultsOutputModelSvc —OK - It was possible to read the collection.
getById()
Returns a specific result.
public
getById(array{id: string} $params) : ResultOutputModelSvc
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the result
Tags
Return values
ResultOutputModelSvc —OK - It was possible to read the resource.
putById()
Returns the result object that was created or updated.
public
putById(array{id: string} $params, ResultInputModelSvc $requestBody) : ResultOutputModelSvc
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the result
- $requestBody : ResultInputModelSvc
-
input model for the result
Tags
Return values
ResultOutputModelSvc —OK - It was possible to read the resource.