Get-PApplications

NAME Get-PApplications



SYNOPSIS

Returns applications based on the filter conditions.





SYNTAX

Get-PApplications [-PopuliUri] <String> [-PopuliAuthkey] <String> [-OffSet <Int32>] [<CommonParameters>]



Get-PApplications [-PopuliUri] <String> [-PopuliAuthkey] <String> -DateField <String> -StartDate <String> -EndDate

<String> [-OffSet <Int32>] [<CommonParameters>]



Get-PApplications [-PopuliUri] <String> [-PopuliAuthkey] <String> [-TermId <Int32>] [-ProgramId <Int32>]

[-DegreeId <Int32>] [-SpecializationId <Int32>] [-OffSet <Int32>] [<CommonParameters>]





DESCRIPTION

You must have the Admissions role to call this task. The "StartDate" and "EndDate" parameters are required when

filtering by the "DateField" parameter.

There is a limit of 200 results in the response. To return more than 200, use the Offset parameter and make

multiple calls.





PARAMETERS

-PopuliUri <String>

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



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.

For more information check the Populi API reference.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DateField <String>

The name of the date field you want to filter by (e.g. APPLIED, DECISION, SUBMITTED, or WITHDRAWN).



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-StartDate <String>

The start date used to filter the "DateField" parameter. Required if using DateField.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EndDate <String>

The end date used to filter the "DateField" parameter. Required if using DateField.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TermId <Int32>

The numeric ID of the academic term you're interested in.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-ProgramId <Int32>

The numeric ID of the program you're interested in.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-DegreeId <Int32>

The numeric ID of the degree you're interested in.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-SpecializationId <Int32>

The numeric ID of the specialization you're interested in.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-OffSet <Int32>

The numeric value you want to offset the results by.



Required? false

Position? named

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:

ApplicationId

LeadId

LeadActive

LeadStatus

PersonId

FirstName

PreferredName

MiddleName

LastName

Gender

Email

ApplicationTemplateId

ApplicationTemplateName

RepresentativeId

ProgramId

ProgramName

DegreeSeeking

DegreeId

DegreeAbbreviation

DegreeName

SpecializationId

SpecializationAbbreviation

SpecializationName

AcademicTermId

AcademicTermName

ExpectedEnrollment

FullTime

StartedOn

SubmittedAt

DecisionOn

WithdrawnOn

SubmittedType

Provisional

FeeStatus

FeeId

FeeAmount

FeePayment

SalesReceiptId

TransactionId

ApplicantActivityAt

NumDaysSinceLastActivity

StaffActivityAt

PercentCompleted

Status





NOTES





Author: Matthew Rehm

Creation Date: 07/15/2019



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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}









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



PS C:\\>Get-PApplications @PopuliCredentials -DateField APPLIED -StartDate 2019-01-01 -EndDate 2019-06-30













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



PS C:\\>Get-PApplications @PopuliCredentials -TermId 223196













-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-PApplications @PopuliCredentials -ProgramId 18081















RELATED LINKS