(PowerShell) IntakeQ: Send a Questionnaire

See more IntakeQ Examples

Send an intake package using the API.

For more information, see https://support.intakeq.com/article/31-intakeq-api#send-questionnaire

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

# Implements the following CURL command:

# curl -H "Content-Type: application/json" \
#      -H 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxxx' \
#      -X POST \
#      -d '{     		
# 	"QuestionnaireId": "00000000-0000-0000-0000-000000000000",     		
# 	"ClientId": 123, 
# 	"ClientName": "Dexter Morgan",
# 	"ClientEmail": "dexter@email.com",
# 	"ClientPhone": "2222222222", 
# 	"PractitionerId": "00000000-0000-0000-0000-000000000000",
# }' https://intakeq.com/api/v1/intakes/send

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "QuestionnaireId": "00000000-0000-0000-0000-000000000000",
#   "ClientId": 123,
#   "ClientName": "Dexter Morgan",
#   "ClientEmail": "dexter@email.com",
#   "ClientPhone": "2222222222",
#   "PractitionerId": "00000000-0000-0000-0000-000000000000"
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("QuestionnaireId","00000000-0000-0000-0000-000000000000")
$json.UpdateInt("ClientId",123)
$json.UpdateString("ClientName","Dexter Morgan")
$json.UpdateString("ClientEmail","dexter@email.com")
$json.UpdateString("ClientPhone","2222222222")
$json.UpdateString("PractitionerId","00000000-0000-0000-0000-000000000000")

$http.SetRequestHeader("Content-Type","application/json")
$http.SetRequestHeader("X-Auth-Key","xxxxxxxxxxxxxxxxxxxxxxxxx")

$resp = $http.PostJson3("https://intakeq.com/api/v1/intakes/send","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "Id": "00000000-0000-0000-0000-000000000000",
#   "ClientName": "test",
#   "ClientEmail": "test@email.com",
#   "ClientId": 9999,
#   "Status": "Completed",
#   "DateCreated": 1458526480368,
#   "DateSubmitted": 1458526532654,
#   "QuestionnaireName": "test",
#   "Practitioner": "test@email.com",
#   "PractitionerName": "FirstName LastName",
#   "Questions": [
#     {
#       "Id": "xxxx-1",
#       "Text": "Full name",
#       "Answer": "Dexter Morgan",
#       "QuestionType": "OpenQuestion",
#       "Rows": [
#       ],
#       "ColumnNames": [
#       ],
#       "OfficeUse": false,
#       "OfficeNote": "aaa"
#     },
#     {
#       "Id": "xxxx-2",
#       "Text": "Full name",
#       "Answer": "Dexter Morgan",
#       "QuestionType": "OpenQuestion",
#       "Rows": [
#       ],
#       "ColumnNames": [
#       ],
#       "OfficeUse": false,
#       "OfficeNote": "aaa"
#     }
#   ],
#   "AppointmentId": "xxxxxxxx",
#   "ConsentForms": [
#     {
#       "Id": "00000000-0000-0000-0000-000000000000",
#       "Name": "HIPAA Release Form",
#       "DocumentType": "Html",
#       "Signed": true,
#       "DateSubmitted": 1458526532654
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$Id = $jResp.StringOf("Id")
$ClientName = $jResp.StringOf("ClientName")
$ClientEmail = $jResp.StringOf("ClientEmail")
$ClientId = $jResp.IntOf("ClientId")
$Status = $jResp.StringOf("Status")
$DateCreated = $jResp.IntOf("DateCreated")
$DateSubmitted = $jResp.IntOf("DateSubmitted")
$QuestionnaireName = $jResp.StringOf("QuestionnaireName")
$Practitioner = $jResp.StringOf("Practitioner")
$PractitionerName = $jResp.StringOf("PractitionerName")
$AppointmentId = $jResp.StringOf("AppointmentId")
$i = 0
$count_i = $jResp.SizeOfArray("Questions")
while ($i -lt $count_i) {
    $jResp.I = $i
    $Id = $jResp.StringOf("Questions[i].Id")
    $Text = $jResp.StringOf("Questions[i].Text")
    $Answer = $jResp.StringOf("Questions[i].Answer")
    $QuestionType = $jResp.StringOf("Questions[i].QuestionType")
    $OfficeUse = $jResp.BoolOf("Questions[i].OfficeUse")
    $OfficeNote = $jResp.StringOf("Questions[i].OfficeNote")
    $j = 0
    $count_j = $jResp.SizeOfArray("Questions[i].Rows")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("Questions[i].ColumnNames")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $j = $j + 1
    }

    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("ConsentForms")
while ($i -lt $count_i) {
    $jResp.I = $i
    $Id = $jResp.StringOf("ConsentForms[i].Id")
    $Name = $jResp.StringOf("ConsentForms[i].Name")
    $DocumentType = $jResp.StringOf("ConsentForms[i].DocumentType")
    $Signed = $jResp.BoolOf("ConsentForms[i].Signed")
    $DateSubmitted = $jResp.IntOf("ConsentForms[i].DateSubmitted")
    $i = $i + 1
}