< Back
Get-PCustomFields
Post
NAME Get-PCustomFields
SYNOPSIS
Returns custom fields attached to a particular person or organization.
SYNTAX
Get-PCustomFields [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [-Type <String>]
[<CommonParameters>]
Get-PCustomFields [-PopuliUri] <String> [-PopuliAuthkey] <String> -OrganizationId <Int32> [-Type <String>]
[<CommonParameters>]
DESCRIPTION
You must have the Staff role to call this task.get
You must have the Staff role to access a person's "PERSON" type custom data.
You must have the Academic Admin or Registrar role to access a person's "STUDENT" type custom data.
You must have the Academic Admin role, Registrar role, Academic Auditor role, or be an advisor of the person to
access their "TERM_STUDENT" type custom data.
You must have the Admissions Admin role, Admissions role, Academic Admin role, or Registrar role to access a
person's "ADMISSIONS" type custom data.
You must have the Campus Life role, Academic Admin role, Registrar role, or Financial Admin role to access a
person's "CAMPUS_LIFE" type custom data.
You must have the Financial Admin role, Student Billing role, or Financial Aid role to access a person's
"FINANCIAL" or "FINANCIAL_AID" type custom data.
You must have the Staff role to access an organization's "ORGANIZATION" type custom data.
For more information about <input_type> see getAllCustomFields
For RADIO, CHECKBOX, and SELECT input types, notice that a numeric <option_index> is returned in addition to the
<value> (this corresponds to the <index> returned by getCustomFieldOptions).
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.
Not Required. Either PersonId OR OrganizationId MUST be set.
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-OrganizationId <Int32>
The numeric ID of the organization you're interested in.
Not Required. Either PersonId OR OrganizationId MUST be set.
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Type <String>
ALL (default), PERSON, STUDENT, TERM_STUDENT, ADMISSIONS, CAMPUS_LIFE, FINANCIAL, or FINANCIAL_AID
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:
CustomFieldId
Name
Type
InputType
Value
OptionIndex
NOTES
Author: Matthew Rehm
Creation Date: 10/03/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-PersonId '7781234'
-------------------------- EXAMPLE 2 --------------------------
Get-PCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-PersonId '7781234' -Type STUDENT
-------------------------- EXAMPLE 3 --------------------------
Get-PCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-OrganizatonId '7781234'
RELATED LINKS
SYNOPSIS
Returns custom fields attached to a particular person or organization.
SYNTAX
Get-PCustomFields [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [-Type <String>]
[<CommonParameters>]
Get-PCustomFields [-PopuliUri] <String> [-PopuliAuthkey] <String> -OrganizationId <Int32> [-Type <String>]
[<CommonParameters>]
DESCRIPTION
You must have the Staff role to call this task.get
You must have the Staff role to access a person's "PERSON" type custom data.
You must have the Academic Admin or Registrar role to access a person's "STUDENT" type custom data.
You must have the Academic Admin role, Registrar role, Academic Auditor role, or be an advisor of the person to
access their "TERM_STUDENT" type custom data.
You must have the Admissions Admin role, Admissions role, Academic Admin role, or Registrar role to access a
person's "ADMISSIONS" type custom data.
You must have the Campus Life role, Academic Admin role, Registrar role, or Financial Admin role to access a
person's "CAMPUS_LIFE" type custom data.
You must have the Financial Admin role, Student Billing role, or Financial Aid role to access a person's
"FINANCIAL" or "FINANCIAL_AID" type custom data.
You must have the Staff role to access an organization's "ORGANIZATION" type custom data.
For more information about <input_type> see getAllCustomFields
For RADIO, CHECKBOX, and SELECT input types, notice that a numeric <option_index> is returned in addition to the
<value> (this corresponds to the <index> returned by getCustomFieldOptions).
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.
Not Required. Either PersonId OR OrganizationId MUST be set.
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-OrganizationId <Int32>
The numeric ID of the organization you're interested in.
Not Required. Either PersonId OR OrganizationId MUST be set.
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Type <String>
ALL (default), PERSON, STUDENT, TERM_STUDENT, ADMISSIONS, CAMPUS_LIFE, FINANCIAL, or FINANCIAL_AID
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:
CustomFieldId
Name
Type
InputType
Value
OptionIndex
NOTES
Author: Matthew Rehm
Creation Date: 10/03/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-PersonId '7781234'
-------------------------- EXAMPLE 2 --------------------------
Get-PCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-PersonId '7781234' -Type STUDENT
-------------------------- EXAMPLE 3 --------------------------
Get-PCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-OrganizatonId '7781234'
RELATED LINKS