Get-PUpdatedPeople

NAME Get-PUpdatedPeople



SYNOPSIS

Returns all people who have had information changed since StartTime.





SYNTAX

Get-PUpdatedPeople [-PopuliUri] <String> [-PopuliAuthkey] <String> -StartTime <DateTime> [<CommonParameters>]





DESCRIPTION

This is useful if you want to sync Populi users to a directory service, etc.





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



-StartTime <DateTime>

Return all people with updated info since this second. Format should be a local timestamp like "2010-11-06

13:27:10".

This parameter is required.



Required? true

Position? named

Default value

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:

PersonId

FirstName

LastName

PreferredName

MiddleName

Prefix

Suffix

FormerName

MaidenName

Gender

BirthDate

Status

IsActiveUser (returns 1 or 0)

UserName

UpdatedAt





NOTES





Author: Matthew Rehm

Creation Date: 02/11/2019



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



Get-PUpdatedPeople -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'

-StartTime (Get-Date).AddDays(-1)













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Get-PUpdatedPeople @PopuliCredentials -StartDate (Get-Date)



>











RELATED LINKS