Chilkat Online Tools

autoit / Salesforce Platform APIs / Group Members—Private

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

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",$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)

; {
;   "requests": [
;     {
;       "createdDate": "2023-11-22T11:46:32.000Z",
;       "id": "0I5...",
;       "lastUpdateDate": "2023-11-22T11:46:32.000Z",
;       "requestedGroup": {
;         "id": "0F9...",
;         "url": "/services/data/v58.0/chatter/groups/0F9..."
;       },
;       "responseMessage": null,
;       "status": "Pending",
;       "url": "/services/data/v58.0/chatter/group-membership-requests/0I5...",
;       "user": {
;         "additionalLabel": null,
;         "communityNickname": "User1700653511864742682",
;         "companyName": null,
;         "displayName": "User Sample",
;         "firstName": "User",
;         "id": "005...",
;         "isActive": true,
;         "isInThisCommunity": true,
;         "lastName": "Sample",
;         "motif": {
;           "color": "1B96FF",
;           "largeIconUrl": "/img/icon/profile64.png",
;           "mediumIconUrl": "/img/icon/profile32.png",
;           "smallIconUrl": "/img/icon/profile16.png",
;           "svgIconUrl": null
;         },
;         "mySubscription": null,
;         "name": "User Sample",
;         "outOfOffice": {
;           "message": ""
;         },
;         "photo": {
;           "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1",
;           "largePhotoUrl": "https://<my_domain>/profilephoto/005/F",
;           "mediumPhotoUrl": "https://<my_domain>/profilephoto/005/M",
;           "photoVersionId": null,
;           "smallPhotoUrl": "https://<my_domain>/profilephoto/005/T",
;           "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1",
;           "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
;         },
;         "reputation": null,
;         "title": null,
;         "type": "User",
;         "url": "/services/data/v58.0/chatter/users/005...",
;         "userType": "Internal"
;       }
;     }
;   ],
;   "total": null
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sCreatedDate
Local $sId
Local $sLastUpdateDate
Local $sId
Local $sV_Url
Local $sResponseMessage
Local $status
Local $sUrl
Local $sAdditionalLabel
Local $sCommunityNickname
Local $sCompanyName
Local $sDisplayName
Local $sFirstName
Local $sUserId
Local $bIsActive
Local $bIsInThisCommunity
Local $sLastName
Local $sColor
Local $sLargeIconUrl
Local $sMediumIconUrl
Local $sSmallIconUrl
Local $sSvgIconUrl
Local $sMySubscription
Local $sName
Local $sMessage
Local $sFullEmailPhotoUrl
Local $sLargePhotoUrl
Local $sMediumPhotoUrl
Local $sPhotoVersionId
Local $sSmallPhotoUrl
Local $sStandardEmailPhotoUrl
Local $sPhotoUrl
Local $sReputation
Local $sTitle
Local $sV_Type
Local $sUserUrl
Local $sUserType

Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("requests")
While $i < $iCount_i
    $oJResp.I = $i
    $sCreatedDate = $oJResp.StringOf("requests[i].createdDate")
    $sId = $oJResp.StringOf("requests[i].id")
    $sLastUpdateDate = $oJResp.StringOf("requests[i].lastUpdateDate")
    $sId = $oJResp.StringOf("requests[i].requestedGroup.id")
    $sV_Url = $oJResp.StringOf("requests[i].requestedGroup.url")
    $sResponseMessage = $oJResp.StringOf("requests[i].responseMessage")
    $status = $oJResp.StringOf("requests[i].status")
    $sUrl = $oJResp.StringOf("requests[i].url")
    $sAdditionalLabel = $oJResp.StringOf("requests[i].user.additionalLabel")
    $sCommunityNickname = $oJResp.StringOf("requests[i].user.communityNickname")
    $sCompanyName = $oJResp.StringOf("requests[i].user.companyName")
    $sDisplayName = $oJResp.StringOf("requests[i].user.displayName")
    $sFirstName = $oJResp.StringOf("requests[i].user.firstName")
    $sUserId = $oJResp.StringOf("requests[i].user.id")
    $bIsActive = $oJResp.BoolOf("requests[i].user.isActive")
    $bIsInThisCommunity = $oJResp.BoolOf("requests[i].user.isInThisCommunity")
    $sLastName = $oJResp.StringOf("requests[i].user.lastName")
    $sColor = $oJResp.StringOf("requests[i].user.motif.color")
    $sLargeIconUrl = $oJResp.StringOf("requests[i].user.motif.largeIconUrl")
    $sMediumIconUrl = $oJResp.StringOf("requests[i].user.motif.mediumIconUrl")
    $sSmallIconUrl = $oJResp.StringOf("requests[i].user.motif.smallIconUrl")
    $sSvgIconUrl = $oJResp.StringOf("requests[i].user.motif.svgIconUrl")
    $sMySubscription = $oJResp.StringOf("requests[i].user.mySubscription")
    $sName = $oJResp.StringOf("requests[i].user.name")
    $sMessage = $oJResp.StringOf("requests[i].user.outOfOffice.message")
    $sFullEmailPhotoUrl = $oJResp.StringOf("requests[i].user.photo.fullEmailPhotoUrl")
    $sLargePhotoUrl = $oJResp.StringOf("requests[i].user.photo.largePhotoUrl")
    $sMediumPhotoUrl = $oJResp.StringOf("requests[i].user.photo.mediumPhotoUrl")
    $sPhotoVersionId = $oJResp.StringOf("requests[i].user.photo.photoVersionId")
    $sSmallPhotoUrl = $oJResp.StringOf("requests[i].user.photo.smallPhotoUrl")
    $sStandardEmailPhotoUrl = $oJResp.StringOf("requests[i].user.photo.standardEmailPhotoUrl")
    $sPhotoUrl = $oJResp.StringOf("requests[i].user.photo.url")
    $sReputation = $oJResp.StringOf("requests[i].user.reputation")
    $sTitle = $oJResp.StringOf("requests[i].user.title")
    $sV_Type = $oJResp.StringOf("requests[i].user.type")
    $sUserUrl = $oJResp.StringOf("requests[i].user.url")
    $sUserType = $oJResp.StringOf("requests[i].user.userType")
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests

Postman Collection Item JSON

{
  "name": "Group Members—Private",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {}
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "chatter",
        "groups",
        ":GROUP_ID",
        "members",
        "requests"
      ],
      "query": [
        {
          "key": "status",
          "value": "Accepted",
          "description": "Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values:\nAccepted\nDeclined\nPending",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "GROUP_ID",
          "value": "0F9..."
        }
      ]
    },
    "description": "Request membership in a private group or get the status of requests to a join a private group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembersRequests.htm"
  },
  "response": [
    {
      "name": "Successful Group Members—Private",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "chatter",
            "groups",
            ":GROUP_ID",
            "members",
            "requests"
          ],
          "query": [
            {
              "key": "status",
              "value": "Accepted",
              "description": "Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values:\nAccepted\nDeclined\nPending",
              "disabled": true
            }
          ],
          "variable": [
            {
              "key": "GROUP_ID",
              "value": "0F9..."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 Nov 2023 11:47:04 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"requests\": [\n        {\n            \"createdDate\": \"2023-11-22T11:46:32.000Z\",\n            \"id\": \"0I5...\",\n            \"lastUpdateDate\": \"2023-11-22T11:46:32.000Z\",\n            \"requestedGroup\": {\n                \"id\": \"0F9...\",\n                \"url\": \"/services/data/v58.0/chatter/groups/0F9...\"\n            },\n            \"responseMessage\": null,\n            \"status\": \"Pending\",\n            \"url\": \"/services/data/v58.0/chatter/group-membership-requests/0I5...\",\n            \"user\": {\n                \"additionalLabel\": null,\n                \"communityNickname\": \"User1700653511864742682\",\n                \"companyName\": null,\n                \"displayName\": \"User Sample\",\n                \"firstName\": \"User\",\n                \"id\": \"005...\",\n                \"isActive\": true,\n                \"isInThisCommunity\": true,\n                \"lastName\": \"Sample\",\n                \"motif\": {\n                    \"color\": \"1B96FF\",\n                    \"largeIconUrl\": \"/img/icon/profile64.png\",\n                    \"mediumIconUrl\": \"/img/icon/profile32.png\",\n                    \"smallIconUrl\": \"/img/icon/profile16.png\",\n                    \"svgIconUrl\": null\n                },\n                \"mySubscription\": null,\n                \"name\": \"User Sample\",\n                \"outOfOffice\": {\n                    \"message\": \"\"\n                },\n                \"photo\": {\n                    \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n                    \"largePhotoUrl\": \"https://<my_domain>/profilephoto/005/F\",\n                    \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/005/M\",\n                    \"photoVersionId\": null,\n                    \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/005/T\",\n                    \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n                    \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n                },\n                \"reputation\": null,\n                \"title\": null,\n                \"type\": \"User\",\n                \"url\": \"/services/data/v58.0/chatter/users/005...\",\n                \"userType\": \"Internal\"\n            }\n        }\n    ],\n    \"total\": null\n}"
    }
  ]
}