Chilkat Online Tools

VB6 / Support API / List Routing Attribute Definitions

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/routing/attributes/definitions",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)

' {
'   "definitions": {
'     "type": "object",
'     "properties": {
'       "conditions_all": {
'         "type": "array",
'         "items": {
'           "type": "object",
'           "properties": {
'             "subject": {
'               "type": "string",
'               "default": "<string>"
'             },
'             "title": {
'               "type": "string",
'               "default": "<string>"
'             }
'           }
'         },
'         "maxItems": 2
'       },
'       "conditions_any": {
'         "type": "array",
'         "items": {
'           "type": "object",
'           "properties": {
'             "subject": {
'               "type": "string",
'               "default": "<string>"
'             },
'             "title": {
'               "type": "string",
'               "default": "<string>"
'             }
'           }
'         },
'         "maxItems": 2
'       }
'     }
'   }
' }

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

Dim v_Type As String
v_Type = jResp.StringOf("definitions.type")
Dim Conditions_allType As String
Conditions_allType = jResp.StringOf("definitions.properties.conditions_all.type")
Dim ItemsType As String
ItemsType = jResp.StringOf("definitions.properties.conditions_all.items.type")
Dim SubjectType As String
SubjectType = jResp.StringOf("definitions.properties.conditions_all.items.properties.subject.type")
Dim Default As String
Default = jResp.StringOf("definitions.properties.conditions_all.items.properties.subject.default")
Dim TitleType As String
TitleType = jResp.StringOf("definitions.properties.conditions_all.items.properties.title.type")
Dim TitleDefault As String
TitleDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.title.default")
Dim MaxItems As Long
MaxItems = jResp.IntOf("definitions.properties.conditions_all.maxItems")
Dim Conditions_anyType As String
Conditions_anyType = jResp.StringOf("definitions.properties.conditions_any.type")
ItemsType = jResp.StringOf("definitions.properties.conditions_any.items.type")
SubjectType = jResp.StringOf("definitions.properties.conditions_any.items.properties.subject.type")
Dim SubjectDefault As String
SubjectDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.subject.default")
TitleType = jResp.StringOf("definitions.properties.conditions_any.items.properties.title.type")
TitleDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.title.default")
Dim Conditions_anyMaxItems As Long
Conditions_anyMaxItems = jResp.IntOf("definitions.properties.conditions_any.maxItems")

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Routing Attribute Definitions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/routing/attributes/definitions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "routing",
        "attributes",
        "definitions"
      ]
    },
    "description": "Returns the condition definitions that can be configured to apply attributes to a ticket.\n\n#### Allowed For\n\n* Admins\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/routing/attributes/definitions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "routing",
            "attributes",
            "definitions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"definitions\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"conditions_all\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      },\n      \"conditions_any\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      }\n    }\n  }\n}"
    }
  ]
}