Get-PFinancialAidYears

NAME Get-PFinancialAidYears



SYNOPSIS

Returns all financial aid years





SYNTAX

Get-PFinancialAidYears [-PopuliUri] <String> [-PopuliAuthkey] <String> [<CommonParameters>]





DESCRIPTION

Returns all financial aid years - note that these are different than calendar years, and each award must be

attached to a financial aid year.

You must have the Financial Aid, Financial Admin or Student Billing role to call this task.





PARAMETERS

-PopuliUri <String>

Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).

This parameter is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PopuliAuthkey <String>

The authentication key with necessary permissions for the data you are requesting. This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Returns PowerShell objects:

AidYearId

AidYearName

StartDate

EndDate





NOTES





Author: Matthew Rehm

Creation Date: 04/03/2019



-------------------------- EXAMPLE 1 --------------------------



Get-PFinancialAidYears -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>#Store your Populi Credentials in a hash table:



$PopuliCredentials = @{

PopuliURI = https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Get-PFinancialAidYears @PopuliCredentials











RELATED LINKS