Chilkat Online Tools

DataFlex / Salesforce Platform APIs / Group Members—Private

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sCreatedDate
    String sId
    String sLastUpdateDate
    String sId
    String sV_Url
    String sResponseMessage
    String sStatus
    String sUrl
    String sAdditionalLabel
    String sCommunityNickname
    String sCompanyName
    String sDisplayName
    String sFirstName
    String sUserId
    Boolean iIsActive
    Boolean iIsInThisCommunity
    String sLastName
    String sColor
    String sLargeIconUrl
    String sMediumIconUrl
    String sSmallIconUrl
    String sSvgIconUrl
    String sMySubscription
    String sName
    String sMessage
    String sFullEmailPhotoUrl
    String sLargePhotoUrl
    String sMediumPhotoUrl
    String sPhotoVersionId
    String sSmallPhotoUrl
    String sStandardEmailPhotoUrl
    String sPhotoUrl
    String sReputation
    String sTitle
    String sV_Type
    String sUserUrl
    String sUserType
    String sTotal
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    // 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

    Get ComStringOf Of hoJResp "total" To sTotal
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "requests" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "requests[i].createdDate" To sCreatedDate
        Get ComStringOf Of hoJResp "requests[i].id" To sId
        Get ComStringOf Of hoJResp "requests[i].lastUpdateDate" To sLastUpdateDate
        Get ComStringOf Of hoJResp "requests[i].requestedGroup.id" To sId
        Get ComStringOf Of hoJResp "requests[i].requestedGroup.url" To sV_Url
        Get ComStringOf Of hoJResp "requests[i].responseMessage" To sResponseMessage
        Get ComStringOf Of hoJResp "requests[i].status" To sStatus
        Get ComStringOf Of hoJResp "requests[i].url" To sUrl
        Get ComStringOf Of hoJResp "requests[i].user.additionalLabel" To sAdditionalLabel
        Get ComStringOf Of hoJResp "requests[i].user.communityNickname" To sCommunityNickname
        Get ComStringOf Of hoJResp "requests[i].user.companyName" To sCompanyName
        Get ComStringOf Of hoJResp "requests[i].user.displayName" To sDisplayName
        Get ComStringOf Of hoJResp "requests[i].user.firstName" To sFirstName
        Get ComStringOf Of hoJResp "requests[i].user.id" To sUserId
        Get ComBoolOf Of hoJResp "requests[i].user.isActive" To iIsActive
        Get ComBoolOf Of hoJResp "requests[i].user.isInThisCommunity" To iIsInThisCommunity
        Get ComStringOf Of hoJResp "requests[i].user.lastName" To sLastName
        Get ComStringOf Of hoJResp "requests[i].user.motif.color" To sColor
        Get ComStringOf Of hoJResp "requests[i].user.motif.largeIconUrl" To sLargeIconUrl
        Get ComStringOf Of hoJResp "requests[i].user.motif.mediumIconUrl" To sMediumIconUrl
        Get ComStringOf Of hoJResp "requests[i].user.motif.smallIconUrl" To sSmallIconUrl
        Get ComStringOf Of hoJResp "requests[i].user.motif.svgIconUrl" To sSvgIconUrl
        Get ComStringOf Of hoJResp "requests[i].user.mySubscription" To sMySubscription
        Get ComStringOf Of hoJResp "requests[i].user.name" To sName
        Get ComStringOf Of hoJResp "requests[i].user.outOfOffice.message" To sMessage
        Get ComStringOf Of hoJResp "requests[i].user.photo.fullEmailPhotoUrl" To sFullEmailPhotoUrl
        Get ComStringOf Of hoJResp "requests[i].user.photo.largePhotoUrl" To sLargePhotoUrl
        Get ComStringOf Of hoJResp "requests[i].user.photo.mediumPhotoUrl" To sMediumPhotoUrl
        Get ComStringOf Of hoJResp "requests[i].user.photo.photoVersionId" To sPhotoVersionId
        Get ComStringOf Of hoJResp "requests[i].user.photo.smallPhotoUrl" To sSmallPhotoUrl
        Get ComStringOf Of hoJResp "requests[i].user.photo.standardEmailPhotoUrl" To sStandardEmailPhotoUrl
        Get ComStringOf Of hoJResp "requests[i].user.photo.url" To sPhotoUrl
        Get ComStringOf Of hoJResp "requests[i].user.reputation" To sReputation
        Get ComStringOf Of hoJResp "requests[i].user.title" To sTitle
        Get ComStringOf Of hoJResp "requests[i].user.type" To sV_Type
        Get ComStringOf Of hoJResp "requests[i].user.url" To sUserUrl
        Get ComStringOf Of hoJResp "requests[i].user.userType" To sUserType
        Move (i + 1) To i
    Loop



End_Procedure

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