Chilkat Online Tools

VB6 / Support API / Ticket Related Information

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/tickets/:ticket_id/related",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)

' {
'   "followup_source_ids": [
'     "<string>",
'     "<string>"
'   ],
'   "from_archive": "<boolean>",
'   "incidents": "<integer>",
'   "topic_id": "<string>",
'   "twitter": {
'     "dolor__1": 77550121,
'     "commodo4b": true
'   }
' }

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

Dim strVal As String

Dim from_archive As String
from_archive = jResp.StringOf("from_archive")
Dim incidents As String
incidents = jResp.StringOf("incidents")
Dim topic_id As String
topic_id = jResp.StringOf("topic_id")
Dim Dolor__1 As Long
Dolor__1 = jResp.IntOf("twitter.dolor__1")
Dim Commodo4b As Long
Commodo4b = jResp.BoolOf("twitter.commodo4b")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("followup_source_ids")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("followup_source_ids[i]")
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "Ticket Related Information",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/related",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "related"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "The request returns a data object with the following properties:\n\n| Name                | Type    | Comment\n| ------------------- | ------- | -------\n| topic_id            | string  | Related topic in the Web portal (deprecated feature)\n| followup_source_ids | array   | Sources to follow up\n| from_archive        | boolean | Is true if the current ticket is archived\n| incidents           | integer | A count of related incident occurrences\n| twitter             | object  | Twitter information associated with the ticket\n\n#### Allowed For\n\n* Agents"
  },
  "response": [
    {
      "name": "Successful 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/related",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "related"
          ],
          "variable": [
            {
              "key": "ticket_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"followup_source_ids\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"from_archive\": \"<boolean>\",\n  \"incidents\": \"<integer>\",\n  \"topic_id\": \"<string>\",\n  \"twitter\": {\n    \"dolor__1\": 77550121,\n    \"commodo4b\": true\n  }\n}"
    }
  ]
}