VB.NET / Support API / Show Many Items
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"
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("identifiers","<string>")
http.SetRequestHeader("Accept","application/json")
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/dynamic_content/items/show_many",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "items": [
' {
' "name": "<string>",
' "default_locale_id": "<integer>",
' "variants": [
' {
' "content": "<string>",
' "locale_id": "<integer>",
' "active": "<boolean>",
' "created_at": "<dateTime>",
' "default": "<boolean>",
' "id": "<integer>",
' "outdated": "<boolean>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' },
' {
' "content": "<string>",
' "locale_id": "<integer>",
' "active": "<boolean>",
' "created_at": "<dateTime>",
' "default": "<boolean>",
' "id": "<integer>",
' "outdated": "<boolean>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' }
' ],
' "created_at": "<dateTime>",
' "id": "<integer>",
' "outdated": "<boolean>",
' "placeholder": "<string>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' },
' {
' "name": "<string>",
' "default_locale_id": "<integer>",
' "variants": [
' {
' "content": "<string>",
' "locale_id": "<integer>",
' "active": "<boolean>",
' "created_at": "<dateTime>",
' "default": "<boolean>",
' "id": "<integer>",
' "outdated": "<boolean>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' },
' {
' "content": "<string>",
' "locale_id": "<integer>",
' "active": "<boolean>",
' "created_at": "<dateTime>",
' "default": "<boolean>",
' "id": "<integer>",
' "outdated": "<boolean>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' }
' ],
' "created_at": "<dateTime>",
' "id": "<integer>",
' "outdated": "<boolean>",
' "placeholder": "<string>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim name As String
Dim default_locale_id As String
Dim created_at As String
Dim id As String
Dim outdated As String
Dim placeholder As String
Dim updated_at As String
Dim url As String
Dim j As Integer
Dim count_j As Integer
Dim content As String
Dim locale_id As String
Dim active As String
Dim default As String
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("items")
While i < count_i
jResp.I = i
name = jResp.StringOf("items[i].name")
default_locale_id = jResp.StringOf("items[i].default_locale_id")
created_at = jResp.StringOf("items[i].created_at")
id = jResp.StringOf("items[i].id")
outdated = jResp.StringOf("items[i].outdated")
placeholder = jResp.StringOf("items[i].placeholder")
updated_at = jResp.StringOf("items[i].updated_at")
url = jResp.StringOf("items[i].url")
j = 0
count_j = jResp.SizeOfArray("items[i].variants")
While j < count_j
jResp.J = j
content = jResp.StringOf("items[i].variants[j].content")
locale_id = jResp.StringOf("items[i].variants[j].locale_id")
active = jResp.StringOf("items[i].variants[j].active")
created_at = jResp.StringOf("items[i].variants[j].created_at")
default = jResp.StringOf("items[i].variants[j].default")
id = jResp.StringOf("items[i].variants[j].id")
outdated = jResp.StringOf("items[i].variants[j].outdated")
updated_at = jResp.StringOf("items[i].variants[j].updated_at")
url = jResp.StringOf("items[i].variants[j].url")
j = j + 1
End While
i = i + 1
End While
Curl Command
curl -u login:password -G -d "identifiers=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/show_many
Postman Collection Item JSON
{
"name": "Show Many Items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
},
"description": "#### Stability\n\n* Development\n\n#### Allowed For\n\n* Admins, 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/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
