Get-PCourseCatalog

NAME Get-PCourseCatalog



SYNOPSIS

Returns courses from your catalog (only active courses are returned by default).





SYNTAX

Get-PCourseCatalog [-PopuliUri] <String> [-PopuliAuthkey] <String> [[-IncludeRetired] <Int32>] [<CommonParameters>]





DESCRIPTION

Useful for automatically syncing your course catalog to your website.





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



-IncludeRetired <Int32>

If set to 1, retired courses will be returned as well.



Required? false

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

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:

CourseId

CourseName

Abbrv

Description

Credits

Hours

Status

DeptId

DeptName

Programs

ProgramId

Program





NOTES





Author: Matthew Rehm

Creation Date: 02/12/2019



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



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













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Get-PCourseCatalog @PopuliCredentials











RELATED LINKS