Public/PropertyTypes/Get-AspirePropertyTypes.ps1
|
<#
.SYNOPSIS Retrieves a list of property types from the Aspire API. .DESCRIPTION Uses Invoke-AspireRequest to perform a GET request to the /PropertyTypes endpoint with support for OData query parameters. .PARAMETER Filter Optional OData filter query (e.g., "Type eq 'Residential'"). .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., "PropertyTypeID,Type"). .PARAMETER Expand Optional comma-separated list of related entities to expand. .OUTPUTS The response from the API containing the list of property types. .EXAMPLE Get-AspirePropertyTypes -Filter "Type eq 'Residential'" -Top 10 #> function Get-AspirePropertyTypes { [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 "/PropertyTypes" -QueryParams $queryParams } |