Get-PStudentInfo

NAME Get-PStudentInfo



SYNOPSIS

Returns student information for a particular person.





SYNTAX

Get-PStudentInfo [-PopuliUri] <String> [-PopuliAuthkey] <String> [[-PersonId] <Int32>] [[-ReturnImageData]

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





DESCRIPTION

If the person has a profile picture, the <image> element will contain base64 encoded binary data.

The <image> element won't be returned unless the person has a profile picture set. You can set a path to save the

image file,

see parameters and examples.

An optional <advisors> element is returned for active students.

An optional <campuses> element is returned if the current user has the Staff role and your school has at least one

campus set up.

<leave_of_absence_start_date> & <leave_of_absence_anticipated_return_date> will only be returned if the

<leave_of_absence> value is "1".





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 Staff role to call this task. This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PersonId <Int32>

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

To call this task for anyone other than yourself, you must have the Registrar role, Academic Admin role, or be

an advisor of the person.

If not set, uses the person_id of the currently logged-in user.



Required? false

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

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? 4

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Path <String>

If requesting ImageData, enter the path to store the image file. The filename will be created using

LastName_FirstName_StudentId.jpg.



Required? false

Position? 5

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:

StudentId

FirstName

LastName

MiddleName

PreferredName

Prefix

Suffix

Gender

BirthDate

Image

EntranceTermId

EntranceTermName

ExitDate

ExitReason

LeaveOfAbsence

LeaveOfAbsenceStartDate

LeaveOfAbsenceAnticipatedReturnDate

Advisors

<Hashtable>

Campuses

<Hashtable>





NOTES





Author: Matthew Rehm

Creation Date: 10/08/2019



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



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

-PersonId '7857760'













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



Get-PStudent @PopuliCredentials -PersonId 7781234 -ReturnImageData 1 -Path "<PATH_TO_SAVE_FILE>"















RELATED LINKS