Get-PCourseInstance

NAME Get-PCourseInstance



SYNOPSIS

A course instance is created each time a course from the catalog is offered in a particular term.

If the same catalog course is offered multiple times in the same term, each instance will have a unique section

number.





SYNTAX

Get-PCourseInstance [-PopuliUri] <String> [-PopuliAuthkey] <String> [-InstanceId] <Int32> [<CommonParameters>]





DESCRIPTION

To get more detail about a course instance see: getCourseInstanceStudents, getCourseInstanceAssignmentGroups,

getCourseInstanceFiles, getCourseInstanceLessons,

and getCourseInstanceMeetings

<max_enrolled> & <max_auditors> can return an empty string meaning "Unlimited" (as opposed to an integer value

which would mean there is a limit).





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.

For more information check the Populi API reference. This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InstanceId <Int32>

The numeric ID of the course instance 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



<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:

InstanceId

Name

Abbrv

Section

Credits

Hours

AffectsEarnedCredits

Description

PassFail

Finalized

TermId

TermName

AllowAuditorAssignments

AllowAuditorAttendance

StartDate

EndDate

OpenToStudentsDate

ClosedToStudentsDate

MaxEnrolled

MaxAuditors

Published

Books {Hashtable - See examples}

MeetingTimes

StartTime

EndTime

Room

Building

Weekdays

PrimaryFaculty

PrimaryFacultyId

PrimaryFacultyFirstname

PrimaryFacultyLastName

PrimaryFacultyPreferredName

PrimaryFacultyDisplayName

PrimaryFacultyIsTeachingAssistant

SecondaryFaculty

SecondaryFacultyId

SecondaryFacultyFirstname

SecondaryFacultyLastName

SecondaryFacultyPreferredName

SecondaryFacultyDisplayName

SecondaryFacultyIsTeachingAssistant





NOTES





Author: Matthew Rehm

Creation Date: 03/13/2019



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



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

-InstanceId '8059238'













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



PS C:\\>Get-PTermCourseInstances @populicredentials -TermId '7289900' | Get-PCourseInstance @populicredentials















RELATED LINKS