Chilkat Online Tools

lianja / Support API / List Assignable Groups

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/groups/assignable",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "groups": [
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "deleted": "<boolean>",
//       "description": "<string>",
//       "id": "<integer>",
//       "is_public": "<boolean>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     },
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "deleted": "<boolean>",
//       "description": "<string>",
//       "id": "<integer>",
//       "is_public": "<boolean>",
//       "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

i = 0
lnCount_i = loJResp.SizeOfArray("groups")
do while i < lnCount_i
    loJResp.I = i
    lcName = loJResp.StringOf("groups[i].name")
    lcCreated_at = loJResp.StringOf("groups[i].created_at")
    lcDefault = loJResp.StringOf("groups[i].default")
    lcDeleted = loJResp.StringOf("groups[i].deleted")
    lcDescription = loJResp.StringOf("groups[i].description")
    lcId = loJResp.StringOf("groups[i].id")
    lcIs_public = loJResp.StringOf("groups[i].is_public")
    lcUpdated_at = loJResp.StringOf("groups[i].updated_at")
    lcUrl = loJResp.StringOf("groups[i].url")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Assignable Groups",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/groups/assignable",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "groups",
        "assignable"
      ]
    },
    "description": "#### 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* 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/groups/assignable",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "groups",
            "assignable"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"groups\": [\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"deleted\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"deleted\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}