Customfields
extends BaseEndpoint
in package
Routing class for the subnamespace `Customfields`
Tags
Table of Contents
Properties
- $_list_ : List_|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- getByUserId() : UserAdminCustomField
- Returns a collection of custom fields for a single ```user\_id```. This includes both user custom fields and administration view only custom fields.
- list_() : UserAdminCustomFieldCollection
- Returns a paginated collection of users with custom admin fields, limited to 100 users per page. This includes both user custom fields and administration view only custom fields.
- patchOnUserId() : bool
- Updates an admin custom field for a user.
- postToUserId() : bool
- Creates an admin custom field for a user.
Properties
$_list_
protected
List_|null
$_list_
= null
$list
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["list_" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Users\\Customfields\\List_"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/customfields"
Methods
getByUserId()
Returns a collection of custom fields for a single ```user\_id```. This includes both user custom fields and administration view only custom fields.
public
getByUserId(array{user_id: int} $params) : UserAdminCustomField
Requires at least one of the following roles in the Education Management system:
- Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The id of the user to get custom fields for.
Tags
Return values
UserAdminCustomField —Success
list_()
Returns a paginated collection of users with custom admin fields, limited to 100 users per page. This includes both user custom fields and administration view only custom fields.
public
list_(array{base_role_ids: string, marker: int, field_ids: string} $params) : UserAdminCustomFieldCollection
Use the last user id number as the marker value to return
the next set of results. For example: marker=23232323 will return
a second set of results beginning with the next user ID in the result
set.
Requires at least one of the following roles in the Education Management system:
- Platform Manager
Parameters
- $params : array{base_role_ids: string, marker: int, field_ids: string}
-
An associative array
- base_role_ids: A comma-delimited list of base role IDs to get
users for. Example:
base\_role\_ids=14,16for Students and Parents. - marker: Format - int32. The user's
idto start at to return the next batch of data. Results will start with the next user in the result set. - field_ids: A comma-delimited list of field IDs to filter the
result set down to. Only matching custom fields will be returned from
that result set for all users in that set even if they don't have any
data for the given
field\_ids.
- base_role_ids: A comma-delimited list of base role IDs to get
users for. Example:
Tags
Return values
UserAdminCustomFieldCollection —Success
patchOnUserId()
Updates an admin custom field for a user.
public
patchOnUserId(array{user_id: int} $params, UserAdminCustomFieldUpdate $requestBody) : bool
Requires at least one of the following roles in the Education Management system:
- Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user to update an existing custom field for.
- $requestBody : UserAdminCustomFieldUpdate
-
Object that describes the custom field that should be updated.
Tags
Return values
bool —Success
postToUserId()
Creates an admin custom field for a user.
public
postToUserId(array{user_id: int} $params, UserAdminCustomFieldCreate $requestBody) : bool
Does not create any of the ten default custom fields, every user has those fields created for them by default. To update those fields see User Custom Field Values Update.
Requires at least one of the following roles in the Education Management system:
- Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user to create a custom field for
- $requestBody : UserAdminCustomFieldCreate
-
Object that describes the custom field that will be created.
Tags
Return values
bool —Success