< Back
Add-PTodo
Post
NAME Add-PTodo
SYNOPSIS
Adds a new todo (the Added By of this new todo will show the currently logged-in user).
SYNTAX
Add-PTodo [-PopuliUri] <String> [-PopuliAuthkey] <String> -Content <String> [-Due <String>] [-AssignedTo <String>]
[-AttachedToType <String>] [-AttachedTo <Int32>] [<CommonParameters>]
DESCRIPTION
Right now you can only attach todos to people, so the only legitimate value for attached_to_type is PERSON.
If you attach a todo onto someone's profile (say a lead or student who needs to be called), it will be visible to
everyone with the Staff role.
If you attach a todo to a person, there will be a handy link to jump to their profile when the todo is displayed
on your dasboard.
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.
The current user must have the Staff role or else be updating an email address on his/her own profile.
This parameter is required.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Content <String>
What the todo should say (e.g. "Remember the milk on the way home from work")
This parameter is required.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Due <String>
The due date for this todo (e.g. 2011-06-24)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AssignedTo <String>
The person responsible for completing this todo. Defaults to the currently logged-in user. When assigning to
another user use PersonId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AttachedToType <String>
If you'd like to attach this todo onto someone's profile, set this to PERSON.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AttachedTo <Int32>
If you'd like to attach this todo onto someone's profile, Use the PersonId (and you MUST have attached_to_type
set to PERSON).
Required? false
Position? named
Default value 0
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:
Id
NOTES
Author: Matthew Rehm
Creation Date: 09/06/2019
-------------------------- EXAMPLE 1 --------------------------
Add-PTodo -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -Content
"Remember the milk on the way home."
-------------------------- EXAMPLE 2 --------------------------
Add-PTodo -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -Content
"Remember the milk on the way home." -Due "2019-09-06"
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Add-PTodo @populicredentials -Content "Create new student accounts." -Due "2019-09-06" -AttachedToType
PERSON -AttachedTo '7857760'
RELATED LINKS
SYNOPSIS
Adds a new todo (the Added By of this new todo will show the currently logged-in user).
SYNTAX
Add-PTodo [-PopuliUri] <String> [-PopuliAuthkey] <String> -Content <String> [-Due <String>] [-AssignedTo <String>]
[-AttachedToType <String>] [-AttachedTo <Int32>] [<CommonParameters>]
DESCRIPTION
Right now you can only attach todos to people, so the only legitimate value for attached_to_type is PERSON.
If you attach a todo onto someone's profile (say a lead or student who needs to be called), it will be visible to
everyone with the Staff role.
If you attach a todo to a person, there will be a handy link to jump to their profile when the todo is displayed
on your dasboard.
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.
The current user must have the Staff role or else be updating an email address on his/her own profile.
This parameter is required.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Content <String>
What the todo should say (e.g. "Remember the milk on the way home from work")
This parameter is required.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Due <String>
The due date for this todo (e.g. 2011-06-24)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AssignedTo <String>
The person responsible for completing this todo. Defaults to the currently logged-in user. When assigning to
another user use PersonId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AttachedToType <String>
If you'd like to attach this todo onto someone's profile, set this to PERSON.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AttachedTo <Int32>
If you'd like to attach this todo onto someone's profile, Use the PersonId (and you MUST have attached_to_type
set to PERSON).
Required? false
Position? named
Default value 0
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:
Id
NOTES
Author: Matthew Rehm
Creation Date: 09/06/2019
-------------------------- EXAMPLE 1 --------------------------
Add-PTodo -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -Content
"Remember the milk on the way home."
-------------------------- EXAMPLE 2 --------------------------
Add-PTodo -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -Content
"Remember the milk on the way home." -Due "2019-09-06"
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Add-PTodo @populicredentials -Content "Create new student accounts." -Due "2019-09-06" -AttachedToType
PERSON -AttachedTo '7857760'
RELATED LINKS