Functions/Get-SchoolRole.ps1
|
function Get-SchoolRole { <# .LINK https://github.com/Sekers/SKYAPI/wiki .LINK Endpoint: https://developer.sky.blackbaud.com/docs/services/school/operations/v1rolesget .SYNOPSIS Education Management School API - Returns a collection of core school user roles. .DESCRIPTION Education Management School API - Returns a collection of core school user roles. Requires at least one of the following roles in the Education Management system: - Academic Group Manager - Activity Group Manager - Advisory Group Manager - Athletic Group Manager - Dorm Group Manager - Dorm Supervisor - Platform Manager - Schedule Manager - SKY API Data Sync .PARAMETER ReturnRaw Returns the raw JSON content of the API call. .EXAMPLE Get-SchoolRole #> [cmdletbinding()] param( [Parameter( Position=0, ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)] [switch]$ReturnRaw ) # Set the endpoints $endpoint = 'https://api.sky.blackbaud.com/school/v1/roles' # Set the response field $ResponseField = "value" # Get the SKY API subscription key $sky_api_config = Get-SKYAPIConfig -ConfigPath $sky_api_config_file_path $sky_api_subscription_key = $sky_api_config.api_subscription_key # Grab the security tokens $AuthTokensFromFile = Get-SKYAPIAuthTokensFromFile if ($ReturnRaw) { $response = Get-SKYAPIUnpagedEntity -url $endpoint -api_key $sky_api_subscription_key -authorisation $AuthTokensFromFile -ReturnRaw return $response } $response = Get-SKYAPIUnpagedEntity -url $endpoint -api_key $sky_api_subscription_key -authorisation $AuthTokensFromFile -response_field $ResponseField $response } |