OrganizationUnits/Get-NcentralServiceOrganizationsCustomers.ps1
|
function Get-NcentralServiceOrganizationsCustomers { <# .SYNOPSIS Get a list of all N-Central Customers under a specific Service Organisation ID .DESCRIPTION This function gets a list of all N-Central Customers under a specific Service Organization ID .PARAMETER ServiceOrganizationID Required. Specifies under which Service Organization ID to list all customers. .PARAMETER PageNumber Optional. Specifies which page of results to retrieve. Used when the total number of users exceeds the page size. Defaults to 1 if not specified .PARAMETER PageSize Optional. Specifies the number of Customers unders a specific Service Organization to retrieve per page. Defaults to 50 if not specified. .PARAMETER All Optional. If specified, retrieves all Customers under a specific Service Organization ID across all pages .PARAMETER Select Optional. Specifies a comma-separated list of fields to return. .PARAMETER SortBy Optional. Specifies the field on which to sort the results. .PARAMETER SortOrder Optional. Specifies the sort order of the results. Valid case-insensitive input is asc, ascending, desc, descending, natural, reverse .EXAMPLE Get-NcentralServiceOrganizations This example fetches all N-Central Service Organization #> [cmdletbinding(DefaultParameterSetName = 'Paged')] param( [Parameter(Mandatory = $true)] [int]$ServiceOrganizationID, [Parameter(Mandatory = $false, ParameterSetName = 'Paged')] [int]$PageNumber = 1, [Parameter(Mandatory = $false, ParameterSetName = 'Paged')] [int]$PageSize = 50, [Parameter(Mandatory = $false, ParameterSetName = 'All')] [switch]$All, [Parameter(Mandatory = $false)] [string]$Select, [Parameter(Mandatory = $false)] [string]$SortBy, [Parameter(Mandatory = $false)] [ValidateSet("asc", "ascending", "desc", "descending", "natural", "reverse")] [string]$SortOrder ) if ($PSBoundParameters.ContainsKey('SortOrder')) { $SortOrder = $SortOrder.ToLower() } switch ($PsCmdlet.ParameterSetName) { 'All' { $uri = "$script:BaseUrl/api/service-orgs/$ServiceOrganizationID/customers?pageNumber=$PageNumber&pageSize=$PageSize" if ($PSBoundParameters.ContainsKey('SortOrder')) { $uri = "$uri&sortOrder=$SortOrder" } if ($PSBoundParameters.ContainsKey('SortBy')) { $uri = "$uri&sortBy=$SortBy" } if ($PSBoundParameters.ContainsKey('Select')) { $uri = "$uri&select=$Select" } $RawData = Invoke-NcentralApi -Uri $uri -Method "GET" $Pages = $RawData.totalPages $Data = New-Object System.Collections.Generic.List[Object] $Data.AddRange($RawData.data) For ($PageNumber = 2; $PageNumber -le $Pages; $PageNumber++) { $uri = "$script:BaseUrl/api/service-orgs/$ServiceOrganizationID/customers?pageNumber=$PageNumber&pageSize=$PageSize" if ($PSBoundParameters.ContainsKey('SortOrder')) { $uri = "$uri&sortOrder=$SortOrder" } if ($PSBoundParameters.ContainsKey('SortBy')) { $uri = "$uri&sortBy=$SortBy" } if ($PSBoundParameters.ContainsKey('Select')) { $uri = "$uri&select=$Select" } $Data.AddRange((Invoke-NcentralApi -Uri $uri -Method "GET").data) } return $Data } 'Paged' { $uri = "$script:BaseUrl/api/service-orgs/$ServiceOrganizationID/customers?pageNumber=$PageNumber&pageSize=$PageSize" if ($PSBoundParameters.ContainsKey('SortOrder')) { $uri = "$uri&sortOrder=$SortOrder" } if ($PSBoundParameters.ContainsKey('SortBy')) { $uri = "$uri&sortBy=$SortBy" } if ($PSBoundParameters.ContainsKey('Select')) { $uri = "$uri&select=$Select" } return (Invoke-NcentralApi -Uri $uri -Method "GET").data } } } |