(Tcl) IntakeQ: Query Intake Forms

Use this method to query client intake form summaries. The result set does not contain all the contents of the intake forms, but only their basic information (id, status, client info).

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Implements the following CURL command:

# curl -X GET \
#   https://intakeq.com/api/v1/intakes/summary?client=[searchString]&startDate=[yyyy-MM-dd]&endDate=[yyyy-MM-dd]&page=[pageNumber]&all=[bool] \
#   -H 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxxx'

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

CkHttp_SetRequestHeader $http "X-Auth-Key" "xxxxxxxxxxxxxxxxxxxxxxxxx"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://intakeq.com/api/v1/intakes/summary?client=[searchString]&startDate=[yyyy-MM-dd]&endDate=[yyyy-MM-dd]&page=[pageNumber]&all=[bool]" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jarrResp [new_CkJsonArray]

CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0

puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonArray $jarrResp
    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",
#     "QuestionnaireId": "1234acbd",
#     "Practitioner": "test@email.com",
#     "PractitionerName": "FirstName LastName"
#   },
#   {
#     "Id": "00000000-0000-0000-0000-000000000000",
#     "ClientName": "test",
#     "ClientEmail": "test@email.com",
#     "ClientId": 9999,
#     "Status": "Completed",
#     "DateCreated": 1458526480368,
#     "DateSubmitted": 1458526532654,
#     "QuestionnaireName": "test",
#     "QuestionnaireId": "1234acbd",
#     "Practitioner": "test@email.com",
#     "PractitionerName": "FirstName LastName"
#   }
# ]

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

# json is a CkJsonObject

set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
    set json [CkJsonArray_ObjectAt $jarrResp $i]
    set Id [CkJsonObject_stringOf $json "Id"]
    set ClientName [CkJsonObject_stringOf $json "ClientName"]
    set ClientEmail [CkJsonObject_stringOf $json "ClientEmail"]
    set ClientId [CkJsonObject_IntOf $json "ClientId"]
    set Status [CkJsonObject_stringOf $json "Status"]
    set DateCreated [CkJsonObject_IntOf $json "DateCreated"]
    set DateSubmitted [CkJsonObject_IntOf $json "DateSubmitted"]
    set QuestionnaireName [CkJsonObject_stringOf $json "QuestionnaireName"]
    set QuestionnaireId [CkJsonObject_stringOf $json "QuestionnaireId"]
    set Practitioner [CkJsonObject_stringOf $json "Practitioner"]
    set PractitionerName [CkJsonObject_stringOf $json "PractitionerName"]
    delete_CkJsonObject $json

    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp