List_
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- patchOnSectionId() : int
- Update the custom field data for an academic section
- postToSectionId() : int
- Add custom field data to an academic section
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/sections/{section_id}/customfields/list"
Endpoint URL pattern
Methods
patchOnSectionId()
Update the custom field data for an academic section
public
patchOnSectionId(array{section_id: int} $params, array<string|int, SectionAdminCustomFieldUpdate> $requestBody) : int
Requires at least one of the following roles in the Education Management system:
-
Academic group manager
-
Platform Manager
***This endpoint is in BETA. It may be removed or replaced with a 90 day deprecation period.***
Parameters
- $params : array{section_id: int}
-
An associative array
- section_id: Format - int32. The Id of the section to update a custom field for
- $requestBody : array<string|int, SectionAdminCustomFieldUpdate>
-
Object that describes the list of custom fields that will be updated for the section.
Tags
Return values
int —Success
postToSectionId()
Add custom field data to an academic section
public
postToSectionId(array{section_id: int} $params, array<string|int, SectionAdminCustomFieldCreate> $requestBody) : int
Requires at least one of the following roles in the Education Management system:
-
Academic group manager
-
Platform Manager
***This endpoint is in BETA. It may be removed or replaced with a 90 day deprecation period.***
Parameters
- $params : array{section_id: int}
-
An associative array
- section_id: Format - int32. The Id of the section to create a custom field for
- $requestBody : array<string|int, SectionAdminCustomFieldCreate>
-
Object that describes the list of custom fields that will be created for the section.
Tags
Return values
int —Success