Set-PTodoCompleted

NAME Set-PTodoCompleted



SYNOPSIS

Marks a todo completed or not completed.





SYNTAX

Set-PTodoCompleted [-PopuliUri] <String> [-PopuliAuthkey] <String> [-TodoId] <Int32> [[-Completed] <Int32>]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

This function can only be used on todos assigned to the currently logged-in user.





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.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TodoId <Int32>

The numeric ID of the todo you're interested in.

Use the Get-PTodos or the Add-PTodo cmdlet to return the TodoId.

This parameter is required.



Required? true

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Completed <Int32>

Possible values: 1 (default) or 0. Whether the todo should be marked completed.

1 = Completed / 0 = Not Completed



Required? false

Position? 4

Default value 0

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

SUCCESS or FAILURE





NOTES





Author: Matthew Rehm

Creation Date: 09/04/2019



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



Set-PTodoCompleted -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'

-TodoId '15940549'













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Set-PTodoCompleted @PopuliCredentials -TodoId '15940549' -Completed 1











RELATED LINKS