Search-PPeople

NAME Search-PPeople



SYNOPSIS

Looks up people by name, email, phone number, etc.





SYNTAX

Search-PPeople [-PopuliUri] <String> [-PopuliAuthkey] <String> -SearchTerm <String> [-Limit <Int32>]

[<CommonParameters>]





DESCRIPTION

Looks up people by name, email, phone number, etc. Metaphone matching is used to try to correct misspellings... so

you can accidentally search

for "Mervin Smith" and hopefully get Marvin Smith returned.

Use Get-PPerson cmdlet to look up more detailed information about one of your search results.





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.

You must have the Staff role to call this task. This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SearchTerm <String>

e.g. "Joe McStudent" or "208-111-2222" or "joe@mcstudent.edu"

This parameter is required.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Limit <Int32>

The maximum number of matches you'd like returned - defaults to 5.



Required? false

Position? named

Default value 5

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:

PersonId

FirstName

LastName

MiddleName

PreferredName

IsUser (Returns 0 or 1)

PrimaryEmail





NOTES





Author: Matthew Rehm

Creation Date: 02/07/2019



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



Search-PPeople -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'

-SearchTerm "Matthew Test"













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Search-PPeople @PopuliCredentials -SearchTerm "Matthew Test" -Limit 1











RELATED LINKS