Public/Get-LimeParticipant.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
Function Get-LimeParticipant {
    <#
    .SYNOPSIS
        GET Participant info on specific LimeSurvey
    .DESCRIPTION
        GET Participant info on specific LimeSurvey
    .PARAMETER SurveyId
        Survey ID to query
    .PARAMETER Session
        LimeSurvey session to use (Created by New-LimeSession)
    .PARAMETER BaseUri
        Base URI for LimeSurvey
    .PARAMETER Raw
        If specified, do not parse output
    .EXAMPLE
        Get-LimeParticipants -SurveyId 123456 -Session $Session -BaseUri https://limehost.com/index.php?r=admin/remotecontrol
    .FUNCTIONALITY
        LimeSurvey
    #>

    [cmdletbinding()]
    Param(
        [parameter(Position = 1)]
        [int]$SurveyId,

        [Parameter( ValueFromPipeLine = $true,
            ValueFromPipelineByPropertyName = $true )]
        [ValidateNotNull()]
        [string]$Session,
        [ValidateNotNull()]
        [string]$BaseUri,
        [switch]$Raw
    )
    Write-Host "$Session $SurveyId $BaseUri" # debug line
    $RpcMethodBody = New-RpcMethod 'list_participants' @($Session, $SurveyId)
    Write-Host $RpcMethodBody
    if ($Raw) {
        $Result = (Invoke-RestMethod -Uri $BaseUri -Method Post -Body $RpcMethodBody).Content
    }
    else {
        $Result = Invoke-RpcMethod -RpcServerUri $BaseUri -RequestBody $RpcMethodBody
    }

    if ($Result.faultCode -ne $null) {
        Write-Error "Fault Code: $($Result.faultCode) . Fault String: $($Result.faultString)"
    }
    else {
        $Result
    }
}