Chilkat Online Tools

autoit / Support API / List Memberships

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/group_memberships",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "group_memberships": [
;     {
;       "user_id": "<integer>",
;       "group_id": "<integer>",
;       "created_at": "<dateTime>",
;       "default": "<boolean>",
;       "id": "<integer>",
;       "updated_at": "<dateTime>",
;       "url": "<string>"
;     },
;     {
;       "user_id": "<integer>",
;       "group_id": "<integer>",
;       "created_at": "<dateTime>",
;       "default": "<boolean>",
;       "id": "<integer>",
;       "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

Local $sUser_id
Local $sGroup_id
Local $sCreated_at
Local $sDefault
Local $sId
Local $sUpdated_at
Local $sUrl

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("group_memberships")
While $i < $iCount_i
    $oJResp.I = $i
    $sUser_id = $oJResp.StringOf("group_memberships[i].user_id")
    $sGroup_id = $oJResp.StringOf("group_memberships[i].group_id")
    $sCreated_at = $oJResp.StringOf("group_memberships[i].created_at")
    $sDefault = $oJResp.StringOf("group_memberships[i].default")
    $sId = $oJResp.StringOf("group_memberships[i].id")
    $sUpdated_at = $oJResp.StringOf("group_memberships[i].updated_at")
    $sUrl = $oJResp.StringOf("group_memberships[i].url")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Memberships",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/group_memberships",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "group_memberships"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>",
          "description": "(Required) The id of the user"
        },
        {
          "key": "group_id",
          "value": "<integer>",
          "description": "(Required) The ID of the group"
        }
      ]
    },
    "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* 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/group_memberships",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "group_memberships"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"group_memberships\": [\n    {\n      \"user_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"user_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}