(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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

http.SetRequestHeader("X-Auth-Key","xxxxxxxxxxxxxxxxxxxxxxxxx")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://intakeq.com/api/v1/intakes/summary?client=[searchString]&startDate=[yyyy-MM-dd]&endDate=[yyyy-MM-dd]&page=[pageNumber]&all=[bool]",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jarrResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

i = 0
count_i = jarrResp.get_Size()
while i < count_i
    # json is a CkJsonObject
    json = jarrResp.ObjectAt(i)
    Id = json.stringOf("Id")
    ClientName = json.stringOf("ClientName")
    ClientEmail = json.stringOf("ClientEmail")
    ClientId = json.IntOf("ClientId")
    Status = json.stringOf("Status")
    DateCreated = json.IntOf("DateCreated")
    DateSubmitted = json.IntOf("DateSubmitted")
    QuestionnaireName = json.stringOf("QuestionnaireName")
    QuestionnaireId = json.stringOf("QuestionnaireId")
    Practitioner = json.stringOf("Practitioner")
    PractitionerName = json.stringOf("PractitionerName")

    i = i + 1
end