Get-PTermEnrollment

NAME Get-PTermEnrollment



SYNOPSIS

Returns term enrollment for a particular academic term.





SYNTAX

Get-PTermEnrollment [-PopuliUri] <String> [-PopuliAuthkey] <String> -TermId <Int32> [<CommonParameters>]





DESCRIPTION

You must have the Academic Admin or Registrar 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.

For more information check the Populi API reference. This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TermId <Int32>

The numeric ID of the term you're interested in. One method for optaining the term id is running the

Get-CurrentAcademicTerm cmdlet. For more information check the Populi API reference.

This parameter is required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

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:

PersonId

AcademicTermId

InstanceId

CatalogCourseId

Status

Credits

Hours

AcademicTermName

Abbrv

CourseName

Section





NOTES





Author: Matthew Rehm

Creation Date: 02/11/2019



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



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

-TermId '7289900'













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



PS C:\\>Get-PCurrentAcademicTerm @PopuliCredentials | Get-PTermEnrollment @PopuliCredentials













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Get-PTermEnrollment @PopuliCredentials -TermId '162200'











RELATED LINKS