Chilkat Online Tools

VB6 / Support API / Show Changes to Ticket

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

http.BasicAuth = 1
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/macros/:macro_id/apply",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "result": {
'     "ticket": {
'       "assignee_id": "<integer>",
'       "comment": {
'         "body": "<string>",
'         "public": "<boolean>",
'         "scoped_body": [
'           [
'             "<string>",
'             "<string>"
'           ],
'           [
'             "<string>",
'             "<string>"
'           ]
'         ]
'       },
'       "fields": {
'         "id": "<integer>",
'         "value": "<string>"
'       },
'       "group_id": "<integer>",
'       "id": "<integer>",
'       "url": "<string>"
'     }
'   }
' }

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

Dim j As Long
Dim count_j As Long
Dim strVal As String

Dim Assignee_id As String
Assignee_id = jResp.StringOf("result.ticket.assignee_id")
Dim Body As String
Body = jResp.StringOf("result.ticket.comment.body")
Dim v_Public As String
v_Public = jResp.StringOf("result.ticket.comment.public")
Dim Id As String
Id = jResp.StringOf("result.ticket.fields.id")
Dim Value As String
Value = jResp.StringOf("result.ticket.fields.value")
Dim Group_id As String
Group_id = jResp.StringOf("result.ticket.group_id")
Dim TicketId As String
TicketId = jResp.StringOf("result.ticket.id")
Dim v_Url As String
v_Url = jResp.StringOf("result.ticket.url")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("result.ticket.comment.scoped_body")
Do While i < count_i
    jResp.I = i
    j = 0
    count_j = jResp.SizeOfArray("result.ticket.comment.scoped_body[i]")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("result.ticket.comment.scoped_body[i][j]")
        j = j + 1
    Loop
    i = i + 1
Loop

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/:macro_id/apply

Postman Collection Item JSON

{
  "name": "Show Changes to Ticket",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/macros/:macro_id/apply",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "macros",
        ":macro_id",
        "apply"
      ],
      "variable": [
        {
          "key": "macro_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns the changes the macro would make to a ticket. It doesn't actually\nchange a ticket. You can use the response data in a subsequent API call\nto the [Tickets](/api-reference/ticketing/tickets/tickets/) endpoint to update the ticket.\n\nThe response includes only the ticket fields that would be changed by the\nmacro. To get the full ticket object after the macro is applied,\nsee [Show Ticket After Changes](#show-ticket-after-changes).\n\n#### Allowed For\n* Agents\n"
  },
  "response": [
    {
      "name": "Success Response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/macros/:macro_id/apply",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "macros",
            ":macro_id",
            "apply"
          ],
          "variable": [
            {
              "key": "macro_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"result\": {\n    \"ticket\": {\n      \"assignee_id\": \"<integer>\",\n      \"comment\": {\n        \"body\": \"<string>\",\n        \"public\": \"<boolean>\",\n        \"scoped_body\": [\n          [\n            \"<string>\",\n            \"<string>\"\n          ],\n          [\n            \"<string>\",\n            \"<string>\"\n          ]\n        ]\n      },\n      \"fields\": {\n        \"id\": \"<integer>\",\n        \"value\": \"<string>\"\n      },\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"url\": \"<string>\"\n    }\n  }\n}"
    }
  ]
}