< Back
Get-PCurrentAcademicTerm
Post
NAME Get-PCurrentAcademicTerm
SYNOPSIS
Returns the current academic term.
SYNTAX
Get-PCurrentAcademicTerm [-PopuliUri] <String> [-PopuliAuthkey] <String> [<CommonParameters>]
DESCRIPTION
Under Academics -> Settings, there is a setting called Default Term. If this is set, then that is what you are
going to get for the current term regardless
of time. Some schools use this to have control over what is considered the "current term" for reports and other
things.
However, by default the setting is set to "automatic". If it's set to automatic, then it will make the best guess
for what term is the "current" term for today.
It will favor standard chronological sequential terms when possible, though if none exists it could return a
non-standard term.
If there is no term of any kind in progress, it will look to the future until it finds one.
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
<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:
TermId
Name
Fullname
StartDate
EndDate
Type
YearId
StartYear
EndYear
NonStandard
NOTES
Author: Matthew Rehm
Creation Date: 12/06/2018
-------------------------- EXAMPLE 1 --------------------------
Get-PCurrentAcademicTerm -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'
RELATED LINKS
SYNOPSIS
Returns the current academic term.
SYNTAX
Get-PCurrentAcademicTerm [-PopuliUri] <String> [-PopuliAuthkey] <String> [<CommonParameters>]
DESCRIPTION
Under Academics -> Settings, there is a setting called Default Term. If this is set, then that is what you are
going to get for the current term regardless
of time. Some schools use this to have control over what is considered the "current term" for reports and other
things.
However, by default the setting is set to "automatic". If it's set to automatic, then it will make the best guess
for what term is the "current" term for today.
It will favor standard chronological sequential terms when possible, though if none exists it could return a
non-standard term.
If there is no term of any kind in progress, it will look to the future until it finds one.
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
<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:
TermId
Name
Fullname
StartDate
EndDate
Type
YearId
StartYear
EndYear
NonStandard
NOTES
Author: Matthew Rehm
Creation Date: 12/06/2018
-------------------------- EXAMPLE 1 --------------------------
Get-PCurrentAcademicTerm -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'
RELATED LINKS