Remove-PTag

NAME Remove-PTag



SYNOPSIS

Removes a tag from a particular person.





SYNTAX

Remove-PTag [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId <Int32>] -TagName <String> [-WhatIf]

[-Confirm] [<CommonParameters>]



Remove-PTag [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId <Int32>] -TagId <Int32> [-WhatIf]

[-Confirm] [<CommonParameters>]





DESCRIPTION

Removes a tag from a particular person using the given parameters. Review the parameters for specific requirements

and settings. The tag_id or tag that you pass in must exist in Populi or a BAD_PARAMETER error will be thrown.

However, this task will return SUCCESS even if the particular person doesn't have the particular tag - Populi will

do nothing in that case.

System tags cannot be removed by anyone other than Populi... so certain tags like "Expelled" are off-limits.

To remove these tags, you'll need to take some action in Populi - the correct system tags will be removed as a

byproduct of that action.





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



-PersonId <Int32>

Numeric ID of the person whose tag should be removed.

Required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-TagId <Int32>

Numeric ID of the tag.

This parameter is not required (but either TagId or TagName must be set)



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-TagName <String>

The actual tag you want to be removed (e.g. "Do not call", or "Good reference").

This parameter is not required (but either TagId or TagName must be set)



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

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

SUCCESS or FAILURE





NOTES





Author: Matthew Rehm

Creation Date: 01/02/2019

Updated: 04/30/2019



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



Remove-PTag -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -PersonId

7851234 -Tag "Test"













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



Remove-PTag -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -PersonId

'7857760' -TagId '12345'















RELATED LINKS