< Back
Get-PPerson
Post
NAME Get-PPerson
SYNOPSIS
Returns basic profile data about a person: name, age, gender, tags, and contact information (address, phone,
email).
SYNTAX
Get-PPerson [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId] <Int32> [[-ReturnImageData] <Int32>]
[[-Path] <String>] [<CommonParameters>]
DESCRIPTION
If the person has a profile picture, the <image> element will contain base64 encoded binary data.
The <image> element won't be returned unless the person has a profile picture set. You can set a path to save the
image file,
see parameters and examples. If multiple school,home, work, other identifiers exist (address, phone, email)
then it will
only return the first one. This was a cmdlet design decision since I think it speaks more to data integrity.
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>
The numeric ID of the person. This parameter is required.
Required? true
Position? 3
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ReturnImageData <Int32>
Boolean (e.g. 1 or 0). Returning binary image data will result in slower response times. Defaults to 0.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Path <String>
Enter the path to store the image file. The filename will be created using
"PersonLastName_PersonFirstName.jpg". It is recommended
to enter a path if you are returning image data.
Required? false
Position? 5
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:
FirstName
LastName
MiddleName
PreferredName
Prefix
Suffix
FormerName
Gender
BirthDate
Citizenship
Citizenships
<Hashtable>
ResidentAlien
HomeCity
HomeState
HomeCountry
LicensePlate
IsActiveUser
Races
<Hashtable>
HispanicLatino
Address
<Home|Work|Billing|School|Shipping|Other>AddressId
<Home|Work|Billing|School|Shipping|Other>AddressStreet
<Home|Work|Billing|School|Shipping|Other>AddressCity
<Home|Work|Billing|School|Shipping|Other>AddressState
<Home|Work|Billing|School|Shipping|Other>AddressZip
<Home|Work|Billing|School|Shipping|Other>AddressCountry
<Home|Work|Billing|School|Shipping|Other>AddressIsPrimary
Phone
<Home|Work|Mobile|School|Fax|Other>Phone
<Home|Work|Mobile|School|Fax|Other>PhoneId
<Home|Work|Mobile|School|Fax|Other>PhoneIsPrimary
Email
<School|Work|Home|Other>Email
<School|Work|Home|Other>EmailId
<School|Work|Home|Other>EmailIsPrimary
Tags
<Hashtable>
NOTES
Author: Matthew Rehm
Creation Date: 12/17/2018
Updated: 03/05/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PPerson -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890' -PersonID
'7857760'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>7857760 | Get-PPerson @PopuliCredentials
-------------------------- EXAMPLE 3 --------------------------
Get-PTaggedPeople @PopuliCredentials -TagName "<ENTER_TAG_NAME>| Get-PPerson @PopuliCredentials -Property
FirstName,LastName,SchoolEmail,SchoolPhone
-------------------------- EXAMPLE 4 --------------------------
Get-PPerson @PopuliCredentials -PersonId 7781234 -ReturnImageData 1 -Path "<PATH_TO_SAVE_FILE>
RELATED LINKS
SYNOPSIS
Returns basic profile data about a person: name, age, gender, tags, and contact information (address, phone,
email).
SYNTAX
Get-PPerson [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId] <Int32> [[-ReturnImageData] <Int32>]
[[-Path] <String>] [<CommonParameters>]
DESCRIPTION
If the person has a profile picture, the <image> element will contain base64 encoded binary data.
The <image> element won't be returned unless the person has a profile picture set. You can set a path to save the
image file,
see parameters and examples. If multiple school,home, work, other identifiers exist (address, phone, email)
then it will
only return the first one. This was a cmdlet design decision since I think it speaks more to data integrity.
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>
The numeric ID of the person. This parameter is required.
Required? true
Position? 3
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ReturnImageData <Int32>
Boolean (e.g. 1 or 0). Returning binary image data will result in slower response times. Defaults to 0.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Path <String>
Enter the path to store the image file. The filename will be created using
"PersonLastName_PersonFirstName.jpg". It is recommended
to enter a path if you are returning image data.
Required? false
Position? 5
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:
FirstName
LastName
MiddleName
PreferredName
Prefix
Suffix
FormerName
Gender
BirthDate
Citizenship
Citizenships
<Hashtable>
ResidentAlien
HomeCity
HomeState
HomeCountry
LicensePlate
IsActiveUser
Races
<Hashtable>
HispanicLatino
Address
<Home|Work|Billing|School|Shipping|Other>AddressId
<Home|Work|Billing|School|Shipping|Other>AddressStreet
<Home|Work|Billing|School|Shipping|Other>AddressCity
<Home|Work|Billing|School|Shipping|Other>AddressState
<Home|Work|Billing|School|Shipping|Other>AddressZip
<Home|Work|Billing|School|Shipping|Other>AddressCountry
<Home|Work|Billing|School|Shipping|Other>AddressIsPrimary
Phone
<Home|Work|Mobile|School|Fax|Other>Phone
<Home|Work|Mobile|School|Fax|Other>PhoneId
<Home|Work|Mobile|School|Fax|Other>PhoneIsPrimary
<School|Work|Home|Other>Email
<School|Work|Home|Other>EmailId
<School|Work|Home|Other>EmailIsPrimary
Tags
<Hashtable>
NOTES
Author: Matthew Rehm
Creation Date: 12/17/2018
Updated: 03/05/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PPerson -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890' -PersonID
'7857760'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>7857760 | Get-PPerson @PopuliCredentials
-------------------------- EXAMPLE 3 --------------------------
Get-PTaggedPeople @PopuliCredentials -TagName "<ENTER_TAG_NAME>| Get-PPerson @PopuliCredentials -Property
FirstName,LastName,SchoolEmail,SchoolPhone
-------------------------- EXAMPLE 4 --------------------------
Get-PPerson @PopuliCredentials -PersonId 7781234 -ReturnImageData 1 -Path "<PATH_TO_SAVE_FILE>
RELATED LINKS