Get-PFinancialAidAwardTypes

NAME Get-PFinancialAidAwardTypes



SYNOPSIS

Returns all available financial aid award types (both active and retired)





SYNTAX

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





DESCRIPTION

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:

AwardTypeId

AwardTypeName

Abbrv

Type

Status

Source

NeedBased (1=Yes / 0=No)

ReportOn1098t (1=Yes / 0=No)

CountAgainstNeed (1=Yes / 0=No)

OnlyAllowWholeDollarAmounts (1=Yes / 0=No)

LiabilityAccountId

LiabilityAccountName

LiabilityAccountNumber





NOTES





Author: Matthew Rehm

Creation Date: 04/03/2019



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



Get-PFinancialAidAwardTypes -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-PFinancialAidAwardTypes @PopuliCredentials











RELATED LINKS