Public/ProspectRatings/Get-AspireProspectRatings.ps1
|
<#
.SYNOPSIS Retrieves a list of prospect ratings from the Aspire API. .DESCRIPTION Uses Invoke-AspireRequest to perform a GET request to the /ProspectRatings endpoint with support for OData query parameters. .PARAMETER Filter Optional OData filter query (e.g., "Rating eq 'High'"). .PARAMETER Top Optional number of records to return (integer). .PARAMETER Skip Optional number of records to skip (integer). .PARAMETER Select Optional comma-separated list of fields to include (e.g., "ProspectRatingID,Rating"). .PARAMETER Expand Optional comma-separated list of related entities to expand. .OUTPUTS The response from the API containing the list of prospect ratings. .EXAMPLE Get-AspireProspectRatings -Filter "Rating eq 'High'" -Top 10 #> function Get-AspireProspectRatings { [CmdletBinding()] param( [string]$Filter = $null, [int]$Top = $null, [int]$Skip = $null, [string]$Select = $null, [string]$Expand = $null ) $queryParams = @{} if ($Filter) { $queryParams['$filter'] = $Filter } if ($Top) { $queryParams['$top'] = $Top } if ($Skip) { $queryParams['$skip'] = $Skip } if ($Select) { $queryParams['$select'] = $Select } if ($Expand) { $queryParams['$expand'] = $Expand } return Invoke-AspireRequest -Method GET -Path "/ProspectRatings" -QueryParams $queryParams } |