LineItems
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- get() : LineItemsOutputModel
- Returns a collection of lineItems.
- getById() : LineItemOutputModel
- Returns a specific lineItem.
- putById() : LineItemOutputModel
- Returns the lineItem object that was created or updated.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/lineItems/{id}"
Methods
get()
Returns a collection of lineItems.
public
get() : LineItemsOutputModel
Return values
LineItemsOutputModel —OK - It was possible to read the collection.
getById()
Returns a specific lineItem.
public
getById(array{id: string} $params) : LineItemOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the lineItem
Tags
Return values
LineItemOutputModel —OK - It was possible to read the resource.
putById()
Returns the lineItem object that was created or updated.
public
putById(array{id: string} $params, LineItemInputModel $requestBody) : LineItemOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the lineItem
- $requestBody : LineItemInputModel
-
input model for the lineItem
Tags
Return values
LineItemOutputModel —OK - It was possible to read the resource.