Get-PFinancialAidAwards

NAME Get-PFinancialAidAwards



SYNOPSIS

Returns all aid awards for a particular aid year (see Get-PFinancialAidYears).





SYNTAX

Get-PFinancialAidAwards [-PopuliUri] <String> [-PopuliAuthkey] <String> [-AidYearId] <Int32> [[-AwardTypeId]

<Int32>] [[-PersonId] <Int32>] [<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



-AidYearId <Int32>

The numeric ID of an aid year (see Get-PFinancialAidYears)

This parameter is required.



Required? true

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-AwardTypeId <Int32>

The numeric ID of an award type (see Get-PFinancialAidAwardTypes).



Required? false

Position? 4

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-PersonId <Int32>

The numeric ID of a student.



Required? false

Position? 5

Default value 0

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:

AwardId

PersonId

LastName

FirstName

StudentId

AwardTypeId

AwardName

AwardAbbrv

AwardType

AwardSource

Status

ScheduledAmount

DisbursedAmount

NetAmount

Amount





NOTES





Author: Matthew Rehm

Creation Date: 04/05/2019



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



PS C:\\># Get the AidAwardYear by first running Get-PFinancialAidYears



Get-PFinancialAidAwards -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'

-AidYearId 22









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



PS C:\\># Run for a specific award year and award type. Run Get-PFinancialAwardTypes to get the AwardTypeId.



Get-PFinancialAidAwards @PopuliCredencials -AidYearId 22 -AwardTypeId 16923









-------------------------- EXAMPLE 3 --------------------------



PS C:\\># Run for a specific award year, award type and person



Get-PFinancialAidAwards @PopuliCredencials -AidYearId 22 -AwardTypeId 16923 -PersonId 7786500











RELATED LINKS