Get-PTodos

NAME Get-PTodos



SYNOPSIS

Returns todos for the current user.





SYNTAX

Get-PTodos [-PopuliUri] <String> [-PopuliAuthkey] <String> [-Completed <String>] [<CommonParameters>]





DESCRIPTION

All times are returned in your school's local timezone.

Right now <attached_to_type> will always be PERSON - in future, you may be able to attach todos to organizations,

etc.

There is a limit of 200 results in the response.





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



-Completed <String>

Possible values: NO (default), YES, or BOTH. Whether you'd like to see completed todos, uncompleted todos, or

all todos.



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:

TodoId

DueDate

Overdue

AssignedTo

AssignedBy

AttachedTo

CompletedTime

AddedTime

Content

AssignedToName

AssignedByName

AttachedToName

AttachedToType





NOTES





Author: Matthew Rehm

Creation Date: 09/04/2019



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



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













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Get-PTodos @PopuliCredentials -Completed BOTH



>











RELATED LINKS