< Back
Get-PAllCustomFields
Post
NAME Get-PAllCustomFields
SYNOPSIS
Returns all custom fields your college has defined.
SYNTAX
Get-PAllCustomFields [-PopuliUri] <String> [-PopuliAuthkey] <String> [-Type <String>] [<CommonParameters>]
DESCRIPTION
You must have the Staff role to call this task.
You must have the Staff role to access "PERSON" type custom fields.
You must have the Academic Admin role to access "STUDENT" type custom fields.
You must have the Academic Admin role to access "TERM_STUDENT" type custom fields.
You must have the Admissions Admin role to access "ADMISSIONS" type custom fields.
You must have the Academic Admin or Registrar role to access "CAMPUS_LIFE" type custom fields.
You must have the Financial Admin role to access "FINANCIAL" type custom fields.
You must have the Financial Aid role to access "FINANCIAL_AID" type custom fields.
You must have the Financial Admin role to access "DONATION" type custom fields.
You must have the Staff role to access "ORGANIZATION" type custom fields.
Return data InputType can be:
DATE - e.g. 2010-09-09
DATE_TIME- e.g. 2010-09-09 19:00:45
DECIMAL - e.g. 10.88
CHECKBOX - Allows multiple values to be selected from a list
FILE - a numeric file_id (e.g. 11111)
INTEGER - e.g. 101
RADIO - Select one from a list of a few options
SELECT - Select one from a list of many options
TEXT_AREA - Lots of text
TEXT - Little bit of text
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
-Type <String>
ALL (default), PERSON, STUDENT, TERM_STUDENT, ADMISSIONS, CAMPUS_LIFE, FINANCIAL, FINANCIAL_AID, DONATION,
ORGANIZATION
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
Description
Type
InputType
NOTES
Author: Matthew Rehm
Creation Date: 10/04/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PAllCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-------------------------- EXAMPLE 2 --------------------------
Get-PAllCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -Type
STUDENT
RELATED LINKS
SYNOPSIS
Returns all custom fields your college has defined.
SYNTAX
Get-PAllCustomFields [-PopuliUri] <String> [-PopuliAuthkey] <String> [-Type <String>] [<CommonParameters>]
DESCRIPTION
You must have the Staff role to call this task.
You must have the Staff role to access "PERSON" type custom fields.
You must have the Academic Admin role to access "STUDENT" type custom fields.
You must have the Academic Admin role to access "TERM_STUDENT" type custom fields.
You must have the Admissions Admin role to access "ADMISSIONS" type custom fields.
You must have the Academic Admin or Registrar role to access "CAMPUS_LIFE" type custom fields.
You must have the Financial Admin role to access "FINANCIAL" type custom fields.
You must have the Financial Aid role to access "FINANCIAL_AID" type custom fields.
You must have the Financial Admin role to access "DONATION" type custom fields.
You must have the Staff role to access "ORGANIZATION" type custom fields.
Return data InputType can be:
DATE - e.g. 2010-09-09
DATE_TIME- e.g. 2010-09-09 19:00:45
DECIMAL - e.g. 10.88
CHECKBOX - Allows multiple values to be selected from a list
FILE - a numeric file_id (e.g. 11111)
INTEGER - e.g. 101
RADIO - Select one from a list of a few options
SELECT - Select one from a list of many options
TEXT_AREA - Lots of text
TEXT - Little bit of text
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
-Type <String>
ALL (default), PERSON, STUDENT, TERM_STUDENT, ADMISSIONS, CAMPUS_LIFE, FINANCIAL, FINANCIAL_AID, DONATION,
ORGANIZATION
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
Description
Type
InputType
NOTES
Author: Matthew Rehm
Creation Date: 10/04/2019
-------------------------- EXAMPLE 1 --------------------------
Get-PAllCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789'
-------------------------- EXAMPLE 2 --------------------------
Get-PAllCustomFields -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -Type
STUDENT
RELATED LINKS