Chilkat Online Tools

VB6 / Support API / Incremental Attributes Export

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

' {
'   "attribute_values": [
'     {
'       "attribute_id": "<string>",
'       "id": "<string>",
'       "name": "<string>",
'       "time": "<dateTime>",
'       "type": "<string>"
'     },
'     {
'       "attribute_id": "<string>",
'       "id": "<string>",
'       "name": "<string>",
'       "time": "<dateTime>",
'       "type": "<string>"
'     }
'   ],
'   "attributes": [
'     {
'       "id": "<string>",
'       "name": "<string>",
'       "time": "<dateTime>",
'       "type": "<string>"
'     },
'     {
'       "id": "<string>",
'       "name": "<string>",
'       "time": "<dateTime>",
'       "type": "<string>"
'     }
'   ],
'   "count": "<integer>",
'   "end_time": "<integer>",
'   "instance_values": [
'     {
'       "attribute_value_id": "<string>",
'       "id": "<string>",
'       "instance_id": "<string>",
'       "time": "<dateTime>",
'       "type": "<string>"
'     },
'     {
'       "attribute_value_id": "<string>",
'       "id": "<string>",
'       "instance_id": "<string>",
'       "time": "<dateTime>",
'       "type": "<string>"
'     }
'   ],
'   "next_page": "<string>"
' }

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

Dim attribute_id As String
Dim id As String
Dim name As String
Dim time As String
Dim v_type As String
Dim attribute_value_id As String
Dim instance_id As String

Dim count As String
count = jResp.StringOf("count")
Dim end_time As String
end_time = jResp.StringOf("end_time")
Dim next_page As String
next_page = jResp.StringOf("next_page")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("attribute_values")
Do While i < count_i
    jResp.I = i
    attribute_id = jResp.StringOf("attribute_values[i].attribute_id")
    id = jResp.StringOf("attribute_values[i].id")
    name = jResp.StringOf("attribute_values[i].name")
    time = jResp.StringOf("attribute_values[i].time")
    v_type = jResp.StringOf("attribute_values[i].type")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("attributes")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("attributes[i].id")
    name = jResp.StringOf("attributes[i].name")
    time = jResp.StringOf("attributes[i].time")
    v_type = jResp.StringOf("attributes[i].type")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("instance_values")
Do While i < count_i
    jResp.I = i
    attribute_value_id = jResp.StringOf("instance_values[i].attribute_value_id")
    id = jResp.StringOf("instance_values[i].id")
    instance_id = jResp.StringOf("instance_values[i].instance_id")
    time = jResp.StringOf("instance_values[i].time")
    v_type = jResp.StringOf("instance_values[i].type")
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "Incremental Attributes Export",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/routing/attributes",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "routing",
        "attributes"
      ]
    },
    "description": "Returns a stream of changes that occurred on routing attributes.\n\n#### Allowed For\n\n* Admins\n\n#### Parameters\n\nOptional\n\n\n| Name   | Type   | Comment\n| ------ | ------ | -------\n| cursor | string | The `cursor` parameter is a non-human-readable argument you can use to move forward or backward in time. The cursor is a read-only URL parameter that's only available in API responses. See [Pagination](#pagination).\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/incremental/routing/attributes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "routing",
            "attributes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attribute_values\": [\n    {\n      \"attribute_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"attribute_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"attributes\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"count\": \"<integer>\",\n  \"end_time\": \"<integer>\",\n  \"instance_values\": [\n    {\n      \"attribute_value_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"instance_id\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"attribute_value_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"instance_id\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"next_page\": \"<string>\"\n}"
    }
  ]
}