Chilkat Online Tools

VB.NET / 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.

Dim http As New Chilkat.Http
Dim success As Boolean

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim createdDate As String
Dim id As String
Dim lastUpdateDate As String
Dim Id As String
Dim v_Url As String
Dim responseMessage As String
Dim status As String
Dim url As String
Dim AdditionalLabel As String
Dim CommunityNickname As String
Dim CompanyName As String
Dim DisplayName As String
Dim FirstName As String
Dim userId As String
Dim IsActive As Boolean
Dim IsInThisCommunity As Boolean
Dim LastName As String
Dim Color As String
Dim LargeIconUrl As String
Dim MediumIconUrl As String
Dim SmallIconUrl As String
Dim SvgIconUrl As String
Dim MySubscription As String
Dim Name As String
Dim Message As String
Dim FullEmailPhotoUrl As String
Dim LargePhotoUrl As String
Dim MediumPhotoUrl As String
Dim PhotoVersionId As String
Dim SmallPhotoUrl As String
Dim StandardEmailPhotoUrl As String
Dim PhotoUrl As String
Dim Reputation As String
Dim Title As String
Dim v_Type As String
Dim userUrl As String
Dim UserType As String

Dim total As String = jResp.StringOf("total")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("requests")
While i < count_i
    jResp.I = i
    createdDate = jResp.StringOf("requests[i].createdDate")
    id = jResp.StringOf("requests[i].id")
    lastUpdateDate = jResp.StringOf("requests[i].lastUpdateDate")
    Id = jResp.StringOf("requests[i].requestedGroup.id")
    v_Url = jResp.StringOf("requests[i].requestedGroup.url")
    responseMessage = jResp.StringOf("requests[i].responseMessage")
    status = jResp.StringOf("requests[i].status")
    url = jResp.StringOf("requests[i].url")
    AdditionalLabel = jResp.StringOf("requests[i].user.additionalLabel")
    CommunityNickname = jResp.StringOf("requests[i].user.communityNickname")
    CompanyName = jResp.StringOf("requests[i].user.companyName")
    DisplayName = jResp.StringOf("requests[i].user.displayName")
    FirstName = jResp.StringOf("requests[i].user.firstName")
    userId = jResp.StringOf("requests[i].user.id")
    IsActive = jResp.BoolOf("requests[i].user.isActive")
    IsInThisCommunity = jResp.BoolOf("requests[i].user.isInThisCommunity")
    LastName = jResp.StringOf("requests[i].user.lastName")
    Color = jResp.StringOf("requests[i].user.motif.color")
    LargeIconUrl = jResp.StringOf("requests[i].user.motif.largeIconUrl")
    MediumIconUrl = jResp.StringOf("requests[i].user.motif.mediumIconUrl")
    SmallIconUrl = jResp.StringOf("requests[i].user.motif.smallIconUrl")
    SvgIconUrl = jResp.StringOf("requests[i].user.motif.svgIconUrl")
    MySubscription = jResp.StringOf("requests[i].user.mySubscription")
    Name = jResp.StringOf("requests[i].user.name")
    Message = jResp.StringOf("requests[i].user.outOfOffice.message")
    FullEmailPhotoUrl = jResp.StringOf("requests[i].user.photo.fullEmailPhotoUrl")
    LargePhotoUrl = jResp.StringOf("requests[i].user.photo.largePhotoUrl")
    MediumPhotoUrl = jResp.StringOf("requests[i].user.photo.mediumPhotoUrl")
    PhotoVersionId = jResp.StringOf("requests[i].user.photo.photoVersionId")
    SmallPhotoUrl = jResp.StringOf("requests[i].user.photo.smallPhotoUrl")
    StandardEmailPhotoUrl = jResp.StringOf("requests[i].user.photo.standardEmailPhotoUrl")
    PhotoUrl = jResp.StringOf("requests[i].user.photo.url")
    Reputation = jResp.StringOf("requests[i].user.reputation")
    Title = jResp.StringOf("requests[i].user.title")
    v_Type = jResp.StringOf("requests[i].user.type")
    userUrl = jResp.StringOf("requests[i].user.url")
    UserType = jResp.StringOf("requests[i].user.userType")
    i = i + 1
End While

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}"
    }
  ]
}