Get-PTaggedPeople

NAME Get-PTaggedPeople



SYNOPSIS

Returns people tagged with a particular tag.





SYNTAX

Get-PTaggedPeople [-PopuliUri] <String> [-PopuliAuthkey] <String> -TagName <String> [<CommonParameters>]



Get-PTaggedPeople [-PopuliUri] <String> [-PopuliAuthkey] <String> -TagId <Int32> [<CommonParameters>]





DESCRIPTION

You must have the Staff role to call this task. There is a limit of 1000 results in the response.

The "num_results" attribute (in the <response> element) indicates the total number of possible results (regardless

of the limit or the page parameter).





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



-TagId <Int32>

Numeric ID of the tag. Not required but either TagId OR tagName MUST be set.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-TagName <String>

Name of the tag. Not required but either TagId OR tagName MUST be set.



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





NOTES





Author: Matthew Rehm

Creation Date: 12/14/2018



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



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

-TagName 'Test'













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



"Test" | Get-PTaggedPeople -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'













-------------------------- EXAMPLE 3 --------------------------



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

'307358'













-------------------------- EXAMPLE 4 --------------------------



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Get-PTaggedPeople @PopuliCredentials -TagId '307358'











RELATED LINKS