Get-PTermStudents

NAME Get-PTermStudents



SYNOPSIS

Returns term students.





SYNTAX

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

[[-CampusId] <String>] [[-ReturnImageData] <Int32>] [[-Path] <String>] [<CommonParameters>]





DESCRIPTION

If the person has a profile picture, the element will contain base64 encoded binary data. The element won't be

returned unless the person has a profile picture set.

There is a limit of 1000 results in the response. The "num_results" attribute (in the <response> element)

indicates the total number of possible results

(regardless of the limit or the page parameter).





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.

You must have the Registrar or Academic Admin role to call this task.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TermId <Int32>

Numeric ID of the term you're interested in. Defaults to the current academic term_id.



Required? false

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-ProgramId <String>

Possible values: ALL (default), NONE, or any numeric program_id.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CampusId <String>

Possible values: ALL (default), 0 (None), or any numeric campus_id.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReturnImageData <Int32>

Boolean (e.g. 1 or 0). Returning binary image data will result in slower response times. Defaults to 0.



Required? false

Position? 6

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Path <String>

If ReturnImageData set to 1, enter the path to store the image file. File name will be

LastName_FirstName_PersonId.jpg.



Required? false

Position? 7

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:

PersonId

StudentId

FirstName

MiddleName

PreferredName

UserName

Prefix

Suffix

FormerName

Gender

BirthDate

Image

ProgramId

ProgramName

Standing

Degree

FullTime

UnitsAttempted

UnitsGranted

TermGpa

CumUnitsGranted

CumGpa

CumGpaIncludingTransfer





NOTES





Author: Matthew Rehm

Creation Date: 01/03/2019



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



PS C:\\>#Returns all students in the current term



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









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



PS C:\\>#Pipe a TermId to Get-PTermStudents



'162800' | Get-PTermStudents @PopuliCred









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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Get-PTermStudents @PopuliCredentials











RELATED LINKS