Chilkat Online Tools

VB.NET / Support API / Show Attachment

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 Chilkat.Http
Dim success As Boolean

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

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/attachments/:attachment_id",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

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


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

' {
'   "attachment": {
'     "content_type": "<string>",
'     "content_url": "<string>",
'     "deleted": "<boolean>",
'     "file_name": "<string>",
'     "height": "<string>",
'     "id": "<integer>",
'     "inline": "<boolean>",
'     "malware_access_override": "<boolean>",
'     "malware_scan_result": "<string>",
'     "mapped_content_url": "<string>",
'     "size": "<integer>",
'     "url": "<string>",
'     "width": "<string>",
'     "thumbnails": [
'       {
'         "content_type": "<string>",
'         "content_url": "<string>",
'         "deleted": "<boolean>",
'         "file_name": "<string>",
'         "height": "<string>",
'         "id": "<integer>",
'         "inline": "<boolean>",
'         "malware_access_override": "<boolean>",
'         "malware_scan_result": "<string>",
'         "mapped_content_url": "<string>",
'         "size": "<integer>",
'         "url": "<string>",
'         "width": "<string>"
'       },
'       {
'         "content_type": "<string>",
'         "content_url": "<string>",
'         "deleted": "<boolean>",
'         "file_name": "<string>",
'         "height": "<string>",
'         "id": "<integer>",
'         "inline": "<boolean>",
'         "malware_access_override": "<boolean>",
'         "malware_scan_result": "<string>",
'         "mapped_content_url": "<string>",
'         "size": "<integer>",
'         "url": "<string>",
'         "width": "<string>"
'       }
'     ]
'   }
' }

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



Dim content_type As String
Dim content_url As String
Dim deleted As String
Dim file_name As String
Dim height As String
Dim id As String
Dim inline As String
Dim malware_access_override As String
Dim malware_scan_result As String
Dim mapped_content_url As String
Dim size As String
Dim url As String
Dim width As String

Dim Content_type As String = jResp.StringOf("attachment.content_type")
Dim Content_url As String = jResp.StringOf("attachment.content_url")
Dim Deleted As String = jResp.StringOf("attachment.deleted")
Dim File_name As String = jResp.StringOf("attachment.file_name")
Dim Height As String = jResp.StringOf("attachment.height")
Dim Id As String = jResp.StringOf("attachment.id")
Dim Inline As String = jResp.StringOf("attachment.inline")
Dim Malware_access_override As String = jResp.StringOf("attachment.malware_access_override")
Dim Malware_scan_result As String = jResp.StringOf("attachment.malware_scan_result")
Dim Mapped_content_url As String = jResp.StringOf("attachment.mapped_content_url")
Dim Size As String = jResp.StringOf("attachment.size")
Dim v_Url As String = jResp.StringOf("attachment.url")
Dim Width As String = jResp.StringOf("attachment.width")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("attachment.thumbnails")
While i < count_i
    jResp.I = i
    content_type = jResp.StringOf("attachment.thumbnails[i].content_type")
    content_url = jResp.StringOf("attachment.thumbnails[i].content_url")
    deleted = jResp.StringOf("attachment.thumbnails[i].deleted")
    file_name = jResp.StringOf("attachment.thumbnails[i].file_name")
    height = jResp.StringOf("attachment.thumbnails[i].height")
    id = jResp.StringOf("attachment.thumbnails[i].id")
    inline = jResp.StringOf("attachment.thumbnails[i].inline")
    malware_access_override = jResp.StringOf("attachment.thumbnails[i].malware_access_override")
    malware_scan_result = jResp.StringOf("attachment.thumbnails[i].malware_scan_result")
    mapped_content_url = jResp.StringOf("attachment.thumbnails[i].mapped_content_url")
    size = jResp.StringOf("attachment.thumbnails[i].size")
    url = jResp.StringOf("attachment.thumbnails[i].url")
    width = jResp.StringOf("attachment.thumbnails[i].width")
    i = i + 1
End While

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Attachment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/attachments/:attachment_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "attachments",
        ":attachment_id"
      ],
      "variable": [
        {
          "key": "attachment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Shows attachment details. You can get the value of the `attachment_id` parameter by listing the ticket's comments.\nSee [List Comments](/api-reference/ticketing/tickets/ticket_comments/#list-comments). Each comment\nin the list has an `attachments` list that specifies an `id` for each attachment.\n\n\n #### Allowed for\n\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/attachments/:attachment_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "attachments",
            ":attachment_id"
          ],
          "variable": [
            {
              "key": "attachment_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attachment\": {\n    \"content_type\": \"<string>\",\n    \"content_url\": \"<string>\",\n    \"deleted\": \"<boolean>\",\n    \"file_name\": \"<string>\",\n    \"height\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"inline\": \"<boolean>\",\n    \"malware_access_override\": \"<boolean>\",\n    \"malware_scan_result\": \"<string>\",\n    \"mapped_content_url\": \"<string>\",\n    \"size\": \"<integer>\",\n    \"url\": \"<string>\",\n    \"width\": \"<string>\",\n    \"thumbnails\": [\n      {\n        \"content_type\": \"<string>\",\n        \"content_url\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"file_name\": \"<string>\",\n        \"height\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"inline\": \"<boolean>\",\n        \"malware_access_override\": \"<boolean>\",\n        \"malware_scan_result\": \"<string>\",\n        \"mapped_content_url\": \"<string>\",\n        \"size\": \"<integer>\",\n        \"url\": \"<string>\",\n        \"width\": \"<string>\"\n      },\n      {\n        \"content_type\": \"<string>\",\n        \"content_url\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"file_name\": \"<string>\",\n        \"height\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"inline\": \"<boolean>\",\n        \"malware_access_override\": \"<boolean>\",\n        \"malware_scan_result\": \"<string>\",\n        \"mapped_content_url\": \"<string>\",\n        \"size\": \"<integer>\",\n        \"url\": \"<string>\",\n        \"width\": \"<string>\"\n      }\n    ]\n  }\n}"
    }
  ]
}