Functions/Get-SchoolTermList.ps1
|
# https://developer.sky.blackbaud.com/docs/services/school/operations/v1termsget # Returns a list of terms. # Parameter,Required,Type,Description # school_year,no,string,The school year to get terms for. Defaults to the current school year if empty. # offering_type,no,integer,The offering type to filter terms by. function Get-SchoolTermList { [cmdletbinding()] Param( [Parameter( ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)] [string]$school_year, [parameter( ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)] [int]$offering_type ) # Set the endpoints $endpoint = 'https://api.sky.blackbaud.com/school/v1/terms' # Set the response field $ResponseField = "value" # Set the parameters $parameters = [System.Web.HttpUtility]::ParseQueryString([String]::Empty) foreach ($parameter in $PSBoundParameters.GetEnumerator()) { $parameters.Add($parameter.Key,$parameter.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 $response = Get-UnpagedEntity -url $endpoint -endUrl $endUrl -api_key $sky_api_subscription_key -authorisation $AuthTokensFromFile -params $parameters -response_field $ResponseField $response } |