List_
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- patchOnCourseId() : int
- Update the custom field data for a course
- postToCourseId() : int
- Add custom field data to a course
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/courses/{course_id}/customfields/list"
Endpoint URL pattern
Methods
patchOnCourseId()
Update the custom field data for a course
public
patchOnCourseId(array{course_id: int} $params, array<string|int, OfferingAdminCustomFieldUpdate> $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{course_id: int}
-
An associative array
- course_id: Format - int32. The ID of the course.
- $requestBody : array<string|int, OfferingAdminCustomFieldUpdate>
-
Object that describes the list of custom fields that will be updated for the course.
Tags
Return values
int —Success
postToCourseId()
Add custom field data to a course
public
postToCourseId(array{course_id: int} $params, array<string|int, OfferingAdminCustomFieldCreate> $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{course_id: int}
-
An associative array
- course_id: Format - int32. The ID of the course.
- $requestBody : array<string|int, OfferingAdminCustomFieldCreate>
-
Object that describes the list of custom fields that will be created for the course.
Tags
Return values
int —Success