Tablevalues
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : TableValueCollection
- Returns a collection of table values.
- post() : AddTableValuesResponse
- Add a new table value to a table type.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/types/tablevalues"
Endpoint URL pattern
Methods
list_()
Returns a collection of table values.
public
list_(array{tableId?: int, tableName: string, includeInactive?: bool} $params) : TableValueCollection
Either tableId or tableName parameter is required, but not
both. For example, If a tableId is provided, then any value
provided for tableName will be ignored. In the case that the
calling user does not have permissions to view the data being requested
no results will be returned.
Parameters
- $params : array{tableId?: int, tableName: string, includeInactive?: bool}
-
An associative array
- tableId: Format - int32. The ID of the table type. The tableId is returned by Types table types or from the settings area for the table within Blackbaud Education Management.
- tableName: The name of the table type. The name is returned by Types table types or from the settings area for the table within Blackbaud Education Management.
- includeInactive: If set to true, returns inactive items for the table. Defaults to false.
Tags
Return values
TableValueCollection —Success
post()
Add a new table value to a table type.
public
post(AddTableValuesRequest $requestBody) : AddTableValuesResponse
Allowed table types: Allergy, Condition, Admission
Parameters
- $requestBody : AddTableValuesRequest
Tags
Return values
AddTableValuesResponse —Success