< Back
Get-PAcademicTerms
Post
NAME Get-PAcademicTerms
SYNOPSIS
Return term information given the selected parameters.
SYNTAX
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> -DateInTerm <DateTime> [<CommonParameters>]
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> -StartDate <String> -EndDate <String>
[<CommonParameters>]
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> -TermName <String> [<CommonParameters>]
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> [-ReturnAll] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-PopuliUri <String>
Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).
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.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StartDate <String>
Start date of the term you are querying. If you enter a start date the end date is required.
Date format is yyyy-MM-dd.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EndDate <String>
End date of the term you are querying. This is required if you enter a start date.
Date format is yyyy-MM-dd.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DateInTerm <DateTime>
Enter a date and it will return the term that date is in. Example would be to run a monthly report based on
the current term.
You can use (Get-Date) or enter a date in format yyyy-MM-dd.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-TermName <String>
Search for a term based on full name of a term. Wildcards are allowed. See Examples.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ReturnAll [<SwitchParameter>]
Returns all terms in XML format.
Required? false
Position? named
Default value False
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: 01/18/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-StartDate 2019-01-07 -EndDate 2019-10-26
-------------------------- EXAMPLE 2 --------------------------
Get-Date | Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey
'123456789'
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-DateInTerm 2019-01-15
-------------------------- EXAMPLE 3 --------------------------
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-TermName "2017-2018: Fall Semester"
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-TermName "Fall Semester"
Get-PAcademicTerms @PopuliCredentials -TermName "2018 *"
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>#Store your Populi Credentials in a hash table:
$PopuliCredentials = @{
PopuliURI = https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/
PopuliAuthkey = '1ReallyLongAlphaNumericSequence'
}
Get-PAcademicTerms @PopuliCredentials -DateInTerm (Get-Date)
RELATED LINKS
SYNOPSIS
Return term information given the selected parameters.
SYNTAX
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> -DateInTerm <DateTime> [<CommonParameters>]
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> -StartDate <String> -EndDate <String>
[<CommonParameters>]
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> -TermName <String> [<CommonParameters>]
Get-PAcademicTerms [-PopuliUri] <String> [-PopuliAuthkey] <String> [-ReturnAll] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-PopuliUri <String>
Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).
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.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StartDate <String>
Start date of the term you are querying. If you enter a start date the end date is required.
Date format is yyyy-MM-dd.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EndDate <String>
End date of the term you are querying. This is required if you enter a start date.
Date format is yyyy-MM-dd.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DateInTerm <DateTime>
Enter a date and it will return the term that date is in. Example would be to run a monthly report based on
the current term.
You can use (Get-Date) or enter a date in format yyyy-MM-dd.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-TermName <String>
Search for a term based on full name of a term. Wildcards are allowed. See Examples.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ReturnAll [<SwitchParameter>]
Returns all terms in XML format.
Required? false
Position? named
Default value False
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: 01/18/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-StartDate 2019-01-07 -EndDate 2019-10-26
-------------------------- EXAMPLE 2 --------------------------
Get-Date | Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey
'123456789'
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-DateInTerm 2019-01-15
-------------------------- EXAMPLE 3 --------------------------
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-TermName "2017-2018: Fall Semester"
Get-PAcademicTerms -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-TermName "Fall Semester"
Get-PAcademicTerms @PopuliCredentials -TermName "2018 *"
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>#Store your Populi Credentials in a hash table:
$PopuliCredentials = @{
PopuliURI = https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/
PopuliAuthkey = '1ReallyLongAlphaNumericSequence'
}
Get-PAcademicTerms @PopuliCredentials -DateInTerm (Get-Date)
RELATED LINKS