< Back
Get-PPersonLeads
Post
NAME Get-PPersonLeads
SYNOPSIS
Returns all leads attached to a person.
SYNTAX
Get-PPersonLeads [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [<CommonParameters>]
DESCRIPTION
You must have the Admissions, Admissions Admin, Registrar, or Academic Admin role to call this task.
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. (See Description.)
This parameter is required.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PersonId <Int32>
The numeric ID of the person you're interested in.
This parameter is required.
Required? true
Position? named
Default value 0
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:
LeadId
FirstName
PreferredName
MiddleName
LastName
Active
MostRecent
AddedOn
RepresentativeId
RepresentativeFirstName
RepresentativePreferredName
RepresentativeMiddleName
RepresentativeLastName
Status
ProgramId
ProgramName
DegreeId
DegreeName
SpecializationId
SpecializationName
TermId
TermName
SourceId
SourceName
SourceComment
EducationLevelId
EducationLevelName
DeclinedReasonId
DeclinedReasonName
DeclinedReasonComment
HighSchoolGradDate
InquiryIds
ApplicationIds
NOTES
Author: Matthew Rehm
Creation Date: 10/31/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PPersonLeads -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -PersonID
7857760
RELATED LINKS
SYNOPSIS
Returns all leads attached to a person.
SYNTAX
Get-PPersonLeads [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [<CommonParameters>]
DESCRIPTION
You must have the Admissions, Admissions Admin, Registrar, or Academic Admin role to call this task.
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. (See Description.)
This parameter is required.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PersonId <Int32>
The numeric ID of the person you're interested in.
This parameter is required.
Required? true
Position? named
Default value 0
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:
LeadId
FirstName
PreferredName
MiddleName
LastName
Active
MostRecent
AddedOn
RepresentativeId
RepresentativeFirstName
RepresentativePreferredName
RepresentativeMiddleName
RepresentativeLastName
Status
ProgramId
ProgramName
DegreeId
DegreeName
SpecializationId
SpecializationName
TermId
TermName
SourceId
SourceName
SourceComment
EducationLevelId
EducationLevelName
DeclinedReasonId
DeclinedReasonName
DeclinedReasonComment
HighSchoolGradDate
InquiryIds
ApplicationIds
NOTES
Author: Matthew Rehm
Creation Date: 10/31/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PPersonLeads -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -PersonID
7857760
RELATED LINKS