< Back
Get-PGradeReport
Post
NAME Get-PGradeReport
SYNOPSIS
Returns the grade report for a particular student and term.
SYNTAX
Get-PGradeReport [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId] <Int32> [-TermId] <Int32>
[[-ProgramId] <Int32>] [[-IncludeLockedGrades] <String>] [-Path] <String> [<CommonParameters>]
DESCRIPTION
You must have the Academic Admin or Registrar role to call this task.
The Content-Type HTTP header will indicate MIME type, and the Content-Disposition header will contain the file
name.
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
-PersonId <Int32>
The numeric ID of the person you're interested in.
This parameter is required.
Required? true
Position? 3
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-TermId <Int32>
The numeric ID of the term you're interested in.
This parameter is required.
Required? true
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ProgramId <Int32>
The numeric ID of the program you're interested in. Default to all programs (program_id 0).
Required? false
Position? 5
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-IncludeLockedGrades <String>
Boolean. Defaults to true.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Path <String>
Enter the path to store the downloaded file. The path will be tested before the backup begins to download. Do
not include the filename.
This will be returned with the downloaded file. Remember to save in a secure location.
This parameter is required.
Required? true
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
PDF file of grade report for selected PersonId and TermId.
NOTES
Author: Matthew Rehm
Creation Date: 10/28/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PPersonLeads -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -PersonID
7857760 -Termid 223196 -Path "c:\\test\\"
RELATED LINKS
SYNOPSIS
Returns the grade report for a particular student and term.
SYNTAX
Get-PGradeReport [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId] <Int32> [-TermId] <Int32>
[[-ProgramId] <Int32>] [[-IncludeLockedGrades] <String>] [-Path] <String> [<CommonParameters>]
DESCRIPTION
You must have the Academic Admin or Registrar role to call this task.
The Content-Type HTTP header will indicate MIME type, and the Content-Disposition header will contain the file
name.
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
-PersonId <Int32>
The numeric ID of the person you're interested in.
This parameter is required.
Required? true
Position? 3
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-TermId <Int32>
The numeric ID of the term you're interested in.
This parameter is required.
Required? true
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ProgramId <Int32>
The numeric ID of the program you're interested in. Default to all programs (program_id 0).
Required? false
Position? 5
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-IncludeLockedGrades <String>
Boolean. Defaults to true.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Path <String>
Enter the path to store the downloaded file. The path will be tested before the backup begins to download. Do
not include the filename.
This will be returned with the downloaded file. Remember to save in a secure location.
This parameter is required.
Required? true
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
PDF file of grade report for selected PersonId and TermId.
NOTES
Author: Matthew Rehm
Creation Date: 10/28/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PPersonLeads -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -PersonID
7857760 -Termid 223196 -Path "c:\\test\\"
RELATED LINKS