Chilkat Online Tools

VB6 / Support API / Show Organization

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/organizations/:organization_id",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)

' {
'   "organization": {
'     "created_at": "<string>",
'     "details": "<string>",
'     "domain_names": [
'       "<string>",
'       "<string>"
'     ],
'     "external_id": "<string>",
'     "group_id": "<integer>",
'     "id": "<integer>",
'     "name": "<string>",
'     "notes": "<string>",
'     "organization_fields": {
'       "fugiat5_0": "<string>",
'       "exercitation_039": "<string>",
'       "laboris_60": "<string>"
'     },
'     "shared_comments": "<boolean>",
'     "shared_tickets": "<boolean>",
'     "tags": [
'       "<string>",
'       "<string>"
'     ],
'     "updated_at": "<string>",
'     "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 strVal As String

Dim Created_at As String
Created_at = jResp.StringOf("organization.created_at")
Dim Details As String
Details = jResp.StringOf("organization.details")
Dim External_id As String
External_id = jResp.StringOf("organization.external_id")
Dim Group_id As String
Group_id = jResp.StringOf("organization.group_id")
Dim Id As String
Id = jResp.StringOf("organization.id")
Dim Name As String
Name = jResp.StringOf("organization.name")
Dim Notes As String
Notes = jResp.StringOf("organization.notes")
Dim Fugiat5_0 As String
Fugiat5_0 = jResp.StringOf("organization.organization_fields.fugiat5_0")
Dim Exercitation_039 As String
Exercitation_039 = jResp.StringOf("organization.organization_fields.exercitation_039")
Dim Laboris_60 As String
Laboris_60 = jResp.StringOf("organization.organization_fields.laboris_60")
Dim Shared_comments As String
Shared_comments = jResp.StringOf("organization.shared_comments")
Dim Shared_tickets As String
Shared_tickets = jResp.StringOf("organization.shared_tickets")
Dim Updated_at As String
Updated_at = jResp.StringOf("organization.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("organization.url")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("organization.domain_names")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("organization.domain_names[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("organization.tags")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("organization.tags[i]")
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Organization",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations",
        ":organization_id"
      ],
      "variable": [
        {
          "key": "organization_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins\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/organizations/:organization_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            ":organization_id"
          ],
          "variable": [
            {
              "key": "organization_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization\": {\n    \"created_at\": \"<string>\",\n    \"details\": \"<string>\",\n    \"domain_names\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"external_id\": \"<string>\",\n    \"group_id\": \"<integer>\",\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"organization_fields\": {\n      \"fugiat5_0\": \"<string>\",\n      \"exercitation_039\": \"<string>\",\n      \"laboris_60\": \"<string>\"\n    },\n    \"shared_comments\": \"<boolean>\",\n    \"shared_tickets\": \"<boolean>\",\n    \"tags\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}