Public/Get-NexosisContestant.ps1
|
Function Get-NexosisContestant { <# .Synopsis Gets all the contestant algorithms which were executed for the given contest. .Description Gets all the contestant algorithms which were executed for the given contest. Note: This endpoint is not available under the community plan. Please upgrade to a paid plan if you are currently on Community. Be sure to use the Paid Subscription key if you have already upgraded. .Parameter SessionId A Session identifier (UUID) of the session contest contestants to retrieve. .Example # Return just the contestants from the contest run for the given serssion Get-NexosisContestant -SessionId 015df24f-7f43-4efe-b8ba-1e28d67eb3fa #>[CmdletBinding()] Param( [Parameter(Mandatory=$true, ValueFromPipeline=$True)] [GUID]$SessionId, [Parameter(Mandatory=$false, ValueFromPipeline=$True)] [GUID]$contestantId, [Parameter(Mandatory=$false, ValueFromPipeline=$True)] $predictionInterval, [Parameter(Mandatory=$false, ValueFromPipeline=$True)] $page, [Parameter(Mandatory=$false, ValueFromPipeline=$True)] $pageSize ) process { # Paging only works with contestantId if ($null -ne $contestantId) { $params = [System.Web.HttpUtility]::ParseQueryString([String]::Empty) if (($null -ne $page) -and ($page -ne 0)) { $params['page'] = $page } if ($null -ne $pageSize) { if ($pageSize -ne ($script:PSNexosisVars.DefaultPageSize)) { $params['pageSize'] = $pageSize } elseif ($script:PSNexosisVars.DefaultPageSize -ne $script:ServerDefaultPageSize) { $params['pageSize'] = $script:PSNexosisVars.DefaultPageSize } } if ($predictionInterval -ne $null) { $params['predictionInterval'] = $predictionInterval } Invoke-Http -method Get -path "sessions/$SessionId/contest/contestants/$contestantId" -params $params } else { if ( ($null -ne $page) -or ($null -ne $pageSize) -or ($null -ne $predictionInterval) ) { throw "Parameter '-sessionId' cannot be used with 'page', 'pageSize', or 'predictionInterval' unless providing '-contestentId'." } $results = Invoke-Http -method Get -path "sessions/$SessionId/contest/contestants" $results.items } } } |