Chilkat Online Tools

VB.NET / Support API / Show Custom Ticket Status

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/custom_statuses/:custom_status_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)

' {
'   "custom_status": {
'     "status_category": "open",
'     "agent_label": "<string>",
'     "active": "<boolean>",
'     "created_at": "<dateTime>",
'     "default": "<boolean>",
'     "description": "<string>",
'     "end_user_description": "<string>",
'     "end_user_label": "<string>",
'     "id": "<integer>",
'     "raw_agent_label": "<string>",
'     "raw_description": "<string>",
'     "raw_end_user_description": "<string>",
'     "raw_end_user_label": "<string>",
'     "updated_at": "<dateTime>"
'   }
' }

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




Dim Status_category As String = jResp.StringOf("custom_status.status_category")
Dim Agent_label As String = jResp.StringOf("custom_status.agent_label")
Dim Active As String = jResp.StringOf("custom_status.active")
Dim Created_at As String = jResp.StringOf("custom_status.created_at")
Dim Default As String = jResp.StringOf("custom_status.default")
Dim Description As String = jResp.StringOf("custom_status.description")
Dim End_user_description As String = jResp.StringOf("custom_status.end_user_description")
Dim End_user_label As String = jResp.StringOf("custom_status.end_user_label")
Dim Id As String = jResp.StringOf("custom_status.id")
Dim Raw_agent_label As String = jResp.StringOf("custom_status.raw_agent_label")
Dim Raw_description As String = jResp.StringOf("custom_status.raw_description")
Dim Raw_end_user_description As String = jResp.StringOf("custom_status.raw_end_user_description")
Dim Raw_end_user_label As String = jResp.StringOf("custom_status.raw_end_user_label")
Dim Updated_at As String = jResp.StringOf("custom_status.updated_at")

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Custom Ticket Status",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_statuses",
        ":custom_status_id"
      ],
      "variable": [
        {
          "key": "custom_status_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns the custom ticket status object.\n\n#### Allowed For\n\n* End Users\n"
  },
  "response": [
    {
      "name": "Custom Status",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_statuses",
            ":custom_status_id"
          ],
          "variable": [
            {
              "key": "custom_status_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_status\": {\n    \"status_category\": \"open\",\n    \"agent_label\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"raw_agent_label\": \"<string>\",\n    \"raw_description\": \"<string>\",\n    \"raw_end_user_description\": \"<string>\",\n    \"raw_end_user_label\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}