Chilkat Online Tools

PureBasic / Support API / Show Audit

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

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

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",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:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "audit": {
    ;     "author_id": "<integer>",
    ;     "created_at": "<dateTime>",
    ;     "events": [
    ;       {
    ;         "proidentb4": true
    ;       },
    ;       {
    ;         "incididunt_dcf": "commodo est mollit laborum"
    ;       }
    ;     ],
    ;     "id": "<integer>",
    ;     "metadata": {
    ;       "aliquip_4": true,
    ;       "cillum_3": 38133397,
    ;       "fugiat_6": "magna",
    ;       "velit_3": -35308847
    ;     },
    ;     "ticket_id": "<integer>",
    ;     "via": {
    ;       "channel": "<string>",
    ;       "source": {
    ;         "fugiatc": 39106364.288705826
    ;       }
    ;     }
    ;   }
    ; }

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

    proidentb4.i
    incididunt_dcf.s

    Author_id.s = CkJsonObject::ckStringOf(jResp,"audit.author_id")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"audit.created_at")
    Id.s = CkJsonObject::ckStringOf(jResp,"audit.id")
    Aliquip_4.i = CkJsonObject::ckBoolOf(jResp,"audit.metadata.aliquip_4")
    Cillum_3.i = CkJsonObject::ckIntOf(jResp,"audit.metadata.cillum_3")
    Fugiat_6.s = CkJsonObject::ckStringOf(jResp,"audit.metadata.fugiat_6")
    Velit_3.i = CkJsonObject::ckIntOf(jResp,"audit.metadata.velit_3")
    Ticket_id.s = CkJsonObject::ckStringOf(jResp,"audit.ticket_id")
    Channel.s = CkJsonObject::ckStringOf(jResp,"audit.via.channel")
    Fugiatc.s = CkJsonObject::ckStringOf(jResp,"audit.via.source.fugiatc")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"audit.events")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        proidentb4 = CkJsonObject::ckBoolOf(jResp,"audit.events[i].proidentb4")
        incididunt_dcf = CkJsonObject::ckStringOf(jResp,"audit.events[i].incididunt_dcf")
        i = i + 1
    Wend


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


    ProcedureReturn
EndProcedure

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id

Postman Collection Item JSON

{
  "name": "Show Audit",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "audits",
        ":ticket_audit_id"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        },
        {
          "key": "ticket_audit_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed for\n\n* Agents\n"
  },
  "response": [
    {
      "name": "OK response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "audits",
            ":ticket_audit_id"
          ],
          "variable": [
            {
              "key": "ticket_id"
            },
            {
              "key": "ticket_audit_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"audit\": {\n    \"author_id\": \"<integer>\",\n    \"created_at\": \"<dateTime>\",\n    \"events\": [\n      {\n        \"proidentb4\": true\n      },\n      {\n        \"incididunt_dcf\": \"commodo est mollit laborum\"\n      }\n    ],\n    \"id\": \"<integer>\",\n    \"metadata\": {\n      \"aliquip_4\": true,\n      \"cillum_3\": 38133397,\n      \"fugiat_6\": \"magna\",\n      \"velit_3\": -35308847\n    },\n    \"ticket_id\": \"<integer>\",\n    \"via\": {\n      \"channel\": \"<string>\",\n      \"source\": {\n        \"fugiatc\": 39106364.288705826\n      }\n    }\n  }\n}"
    }
  ]
}