Chilkat Online Tools

VB6 / Support API / List Sharing Agreements

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/sharing_agreements",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)

' {
'   "sharing_agreements": [
'     {
'       "created_at": "<dateTime>",
'       "id": "<integer>",
'       "name": "<string>",
'       "partner_name": "<string>",
'       "remote_subdomain": "<string>",
'       "status": "<string>",
'       "type": "<string>",
'       "url": "<string>"
'     },
'     {
'       "created_at": "<dateTime>",
'       "id": "<integer>",
'       "name": "<string>",
'       "partner_name": "<string>",
'       "remote_subdomain": "<string>",
'       "status": "<string>",
'       "type": "<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 created_at As String
Dim id As String
Dim name As String
Dim partner_name As String
Dim remote_subdomain As String
Dim status As String
Dim v_type As String
Dim url As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("sharing_agreements")
Do While i < count_i
    jResp.I = i
    created_at = jResp.StringOf("sharing_agreements[i].created_at")
    id = jResp.StringOf("sharing_agreements[i].id")
    name = jResp.StringOf("sharing_agreements[i].name")
    partner_name = jResp.StringOf("sharing_agreements[i].partner_name")
    remote_subdomain = jResp.StringOf("sharing_agreements[i].remote_subdomain")
    status = jResp.StringOf("sharing_agreements[i].status")
    v_type = jResp.StringOf("sharing_agreements[i].type")
    url = jResp.StringOf("sharing_agreements[i].url")
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Sharing Agreements",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/sharing_agreements",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sharing_agreements"
      ]
    },
    "description": "#### 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/sharing_agreements",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sharing_agreements"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sharing_agreements\": [\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"partner_name\": \"<string>\",\n      \"remote_subdomain\": \"<string>\",\n      \"status\": \"<string>\",\n      \"type\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"partner_name\": \"<string>\",\n      \"remote_subdomain\": \"<string>\",\n      \"status\": \"<string>\",\n      \"type\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}