(PureBasic) Zendesk List Users

See more Zendesk Examples

List users.

For more information, see https://developer.zendesk.com/api-reference/ticketing/users/users/#list-users

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.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 https://{subdomain}.zendesk.com/api/v2/users.json
    ;    -u {email_address}:{password_or_api_token}

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

    CkHttp::setCkBasicAuth(http, 1)
    ; To authenticate using your email address + password, do this:
    CkHttp::setCkLogin(http, "joe@example.com")
    CkHttp::setCkPassword(http, "your_password")

    ; Alternatively, to authenticate using your email address + API token, do this:
    ; (The login is the concatenation of your email address with the string "/token".  For example: "joe@somewhere.com/token")
    CkHttp::setCkLogin(http, "joe@example.com/token")
    CkHttp::setCkPassword(http, "your_api_token")

    ; Chilkat's subdomain is "chilkatsoft".  You will change "chilkatsoft" to use your subdomain.
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://chilkatsoft.zendesk.com/api/v2/users.json",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    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)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure