VB6 / Support API / List Organization Fields
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/organization_fields",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)
' {
' "count": "<integer>",
' "next_page": "<string>",
' "organization_fields": [
' {
' "key": "<string>",
' "type": "<string>",
' "title": "<string>",
' "active": "<boolean>",
' "created_at": "<dateTime>",
' "custom_field_options": [
' {
' "name": "<string>",
' "value": "<string>",
' "id": "<integer>",
' "position": "<integer>",
' "raw_name": "<string>",
' "url": "<string>"
' },
' {
' "name": "<string>",
' "value": "<string>",
' "id": "<integer>",
' "position": "<integer>",
' "raw_name": "<string>",
' "url": "<string>"
' }
' ],
' "description": "<string>",
' "id": "<integer>",
' "position": "<integer>",
' "raw_description": "<string>",
' "raw_title": "<string>",
' "regexp_for_validation": "<string>",
' "relationship_filter": {},
' "relationship_target_type": "<string>",
' "system": "<boolean>",
' "tag": "<string>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' },
' {
' "key": "<string>",
' "type": "<string>",
' "title": "<string>",
' "active": "<boolean>",
' "created_at": "<dateTime>",
' "custom_field_options": [
' {
' "name": "<string>",
' "value": "<string>",
' "id": "<integer>",
' "position": "<integer>",
' "raw_name": "<string>",
' "url": "<string>"
' },
' {
' "name": "<string>",
' "value": "<string>",
' "id": "<integer>",
' "position": "<integer>",
' "raw_name": "<string>",
' "url": "<string>"
' }
' ],
' "description": "<string>",
' "id": "<integer>",
' "position": "<integer>",
' "raw_description": "<string>",
' "raw_title": "<string>",
' "regexp_for_validation": "<string>",
' "relationship_filter": {},
' "relationship_target_type": "<string>",
' "system": "<boolean>",
' "tag": "<string>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' }
' ],
' "previous_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 key As String
Dim v_type As String
Dim title As String
Dim active As String
Dim created_at As String
Dim description As String
Dim id As String
Dim position As String
Dim raw_description As String
Dim raw_title As String
Dim regexp_for_validation As String
Dim relationship_target_type As String
Dim system As String
Dim tag As String
Dim updated_at As String
Dim url As String
Dim j As Long
Dim count_j As Long
Dim name As String
Dim value As String
Dim raw_name As String
Dim count As String
count = jResp.StringOf("count")
Dim next_page As String
next_page = jResp.StringOf("next_page")
Dim previous_page As String
previous_page = jResp.StringOf("previous_page")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("organization_fields")
Do While i < count_i
jResp.I = i
key = jResp.StringOf("organization_fields[i].key")
v_type = jResp.StringOf("organization_fields[i].type")
title = jResp.StringOf("organization_fields[i].title")
active = jResp.StringOf("organization_fields[i].active")
created_at = jResp.StringOf("organization_fields[i].created_at")
description = jResp.StringOf("organization_fields[i].description")
id = jResp.StringOf("organization_fields[i].id")
position = jResp.StringOf("organization_fields[i].position")
raw_description = jResp.StringOf("organization_fields[i].raw_description")
raw_title = jResp.StringOf("organization_fields[i].raw_title")
regexp_for_validation = jResp.StringOf("organization_fields[i].regexp_for_validation")
relationship_target_type = jResp.StringOf("organization_fields[i].relationship_target_type")
system = jResp.StringOf("organization_fields[i].system")
tag = jResp.StringOf("organization_fields[i].tag")
updated_at = jResp.StringOf("organization_fields[i].updated_at")
url = jResp.StringOf("organization_fields[i].url")
j = 0
count_j = jResp.SizeOfArray("organization_fields[i].custom_field_options")
Do While j < count_j
jResp.J = j
name = jResp.StringOf("organization_fields[i].custom_field_options[j].name")
value = jResp.StringOf("organization_fields[i].custom_field_options[j].value")
id = jResp.StringOf("organization_fields[i].custom_field_options[j].id")
position = jResp.StringOf("organization_fields[i].custom_field_options[j].position")
raw_name = jResp.StringOf("organization_fields[i].custom_field_options[j].raw_name")
url = jResp.StringOf("organization_fields[i].custom_field_options[j].url")
j = j + 1
Loop
i = i + 1
Loop
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organization_fields
Postman Collection Item JSON
{
"name": "List Organization Fields",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organization_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_fields"
]
},
"description": "Returns a list of custom organization fields in your account. Fields are returned in the order that you specify in your organization fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each organization field to the values returned under the `organization_fields` attribute on the [organization](/api-reference/ticketing/organizations/organizations/) resource.\n\n#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\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/organization_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_fields"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"organization_fields\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"previous_page\": \"<string>\"\n}"
}
]
}
