< Back

Get-PInquiry

Sat Jan 18, 2020 7:27 pm

NAME Get-PInquiry



SYNOPSIS

Returns a particular admissions inquiry.





SYNTAX

Get-PInquiry [-PopuliUri] <String> [-PopuliAuthkey] <String> -InquiryId <Int32> [<CommonParameters>]





DESCRIPTION

You must have one of these roles to call this task: Admissions, Admissions Admin.





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



-InquiryId <Int32>

The numeric ID of the inquiry.

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:

InquiryId

PersonId

LeadId

FirstName

MiddleName

LastName

Email

Phone

AddressId

Subject

Content

ProgramId

DegreeId

SpecializationId

AcademicTermId

CounselorId

AutoAssignedTo

Status

LeadSourceId

LocalizationId

AddedOn

AddedBy

AddedAt

DeletedBy

DeletedAt





NOTES





Author: Matthew Rehm

Creation Date: 10/30/2019



-------------------------- EXAMPLE 1 --------------------------



Get-PInquiry -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '123456789' -InquiryId 13















RELATED LINKS