(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonArray.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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::ckSetRequestHeader(http,"X-Auth-Key","xxxxxxxxxxxxxxxxxxxxxxxxx")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(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
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jarrResp.i = CkJsonArray::ckCreate()
    If jarrResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckLoadSb(jarrResp,sbResponseBody)
    CkJsonArray::setCkEmitCompact(jarrResp, 0)

    Debug "Response Body:"
    Debug CkJsonArray::ckEmit(jarrResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonArray::ckDispose(jarrResp)
        ProcedureReturn
    EndIf

    ; 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.i
    Id.s
    ClientName.s
    ClientEmail.s
    ClientId.i
    Status.s
    DateCreated.i
    DateSubmitted.i
    QuestionnaireName.s
    QuestionnaireId.s
    Practitioner.s
    PractitionerName.s

    i.i = 0
    count_i.i = CkJsonArray::ckSize(jarrResp)
    While i < count_i
        json = CkJsonArray::ckObjectAt(jarrResp,i)
        Id = CkJsonObject::ckStringOf(json,"Id")
        ClientName = CkJsonObject::ckStringOf(json,"ClientName")
        ClientEmail = CkJsonObject::ckStringOf(json,"ClientEmail")
        ClientId = CkJsonObject::ckIntOf(json,"ClientId")
        Status = CkJsonObject::ckStringOf(json,"Status")
        DateCreated = CkJsonObject::ckIntOf(json,"DateCreated")
        DateSubmitted = CkJsonObject::ckIntOf(json,"DateSubmitted")
        QuestionnaireName = CkJsonObject::ckStringOf(json,"QuestionnaireName")
        QuestionnaireId = CkJsonObject::ckStringOf(json,"QuestionnaireId")
        Practitioner = CkJsonObject::ckStringOf(json,"Practitioner")
        PractitionerName = CkJsonObject::ckStringOf(json,"PractitionerName")
        CkJsonObject::ckDispose(json)

        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonArray::ckDispose(jarrResp)


    ProcedureReturn
EndProcedure