Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Group Members

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcLastFeedAccessDate
LOCAL lcRole
LOCAL lcUrl
LOCAL lcAdditionalLabel
LOCAL lcCommunityNickname
LOCAL lcCompanyName
LOCAL lcDisplayName
LOCAL lcFirstName
LOCAL lcId
LOCAL lnIsActive
LOCAL lnIsInThisCommunity
LOCAL lcLastName
LOCAL lcColor
LOCAL lcLargeIconUrl
LOCAL lcMediumIconUrl
LOCAL lcSmallIconUrl
LOCAL lcSvgIconUrl
LOCAL lcMySubscription
LOCAL lcName
LOCAL lcMessage
LOCAL lcFullEmailPhotoUrl
LOCAL lcLargePhotoUrl
LOCAL lcMediumPhotoUrl
LOCAL lcPhotoVersionId
LOCAL lcSmallPhotoUrl
LOCAL lcStandardEmailPhotoUrl
LOCAL lcV_Url
LOCAL lcReputation
LOCAL lcTitle
LOCAL lcV_Type
LOCAL lcUserUrl
LOCAL lcUserType

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.QuickRequest("POST","https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>")
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

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

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "id": "0FB...",
*   "lastFeedAccessDate": null,
*   "role": "StandardMember",
*   "url": "/services/data/v58.0/chatter/group-memberships/0FB...",
*   "user": {
*     "additionalLabel": null,
*     "communityNickname": "integration1.4407085834085586E12",
*     "companyName": "Salesforce",
*     "displayName": "Integration User",
*     "firstName": "Integration",
*     "id": "005...",
*     "isActive": true,
*     "isInThisCommunity": true,
*     "lastName": "User",
*     "motif": {
*       "color": "1B96FF",
*       "largeIconUrl": "/img/icon/profile64.png",
*       "mediumIconUrl": "/img/icon/profile32.png",
*       "smallIconUrl": "/img/icon/profile16.png",
*       "svgIconUrl": null
*     },
*     "mySubscription": null,
*     "name": "Integration User",
*     "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"
*   }
* }

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

lcId = loJResp.StringOf("id")
lcLastFeedAccessDate = loJResp.StringOf("lastFeedAccessDate")
lcRole = loJResp.StringOf("role")
lcUrl = loJResp.StringOf("url")
lcAdditionalLabel = loJResp.StringOf("user.additionalLabel")
lcCommunityNickname = loJResp.StringOf("user.communityNickname")
lcCompanyName = loJResp.StringOf("user.companyName")
lcDisplayName = loJResp.StringOf("user.displayName")
lcFirstName = loJResp.StringOf("user.firstName")
lcId = loJResp.StringOf("user.id")
lnIsActive = loJResp.BoolOf("user.isActive")
lnIsInThisCommunity = loJResp.BoolOf("user.isInThisCommunity")
lcLastName = loJResp.StringOf("user.lastName")
lcColor = loJResp.StringOf("user.motif.color")
lcLargeIconUrl = loJResp.StringOf("user.motif.largeIconUrl")
lcMediumIconUrl = loJResp.StringOf("user.motif.mediumIconUrl")
lcSmallIconUrl = loJResp.StringOf("user.motif.smallIconUrl")
lcSvgIconUrl = loJResp.StringOf("user.motif.svgIconUrl")
lcMySubscription = loJResp.StringOf("user.mySubscription")
lcName = loJResp.StringOf("user.name")
lcMessage = loJResp.StringOf("user.outOfOffice.message")
lcFullEmailPhotoUrl = loJResp.StringOf("user.photo.fullEmailPhotoUrl")
lcLargePhotoUrl = loJResp.StringOf("user.photo.largePhotoUrl")
lcMediumPhotoUrl = loJResp.StringOf("user.photo.mediumPhotoUrl")
lcPhotoVersionId = loJResp.StringOf("user.photo.photoVersionId")
lcSmallPhotoUrl = loJResp.StringOf("user.photo.smallPhotoUrl")
lcStandardEmailPhotoUrl = loJResp.StringOf("user.photo.standardEmailPhotoUrl")
lcV_Url = loJResp.StringOf("user.photo.url")
lcReputation = loJResp.StringOf("user.reputation")
lcTitle = loJResp.StringOf("user.title")
lcV_Type = loJResp.StringOf("user.type")
lcUserUrl = loJResp.StringOf("user.url")
lcUserType = loJResp.StringOf("user.userType")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>

Postman Collection Item JSON

{
  "name": "Group Members",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {}
  },
  "request": {
    "method": "POST",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "chatter",
        "groups",
        ":GROUP_ID",
        "members"
      ],
      "query": [
        {
          "key": "userId",
          "value": "<USER1_ID>"
        }
      ],
      "variable": [
        {
          "key": "GROUP_ID",
          "value": ""
        }
      ]
    },
    "description": "Members of a specified group. Get the members and add a member to a group. To add a member, the context user must be the group owner or moderator.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembers.htm"
  },
  "response": [
    {
      "name": "Successful Group Members",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=005...",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "chatter",
            "groups",
            ":GROUP_ID",
            "members"
          ],
          "query": [
            {
              "key": "userId",
              "value": "005..."
            }
          ],
          "variable": [
            {
              "key": "GROUP_ID",
              "value": "0F9..."
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 Nov 2023 11:31:07 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    \"id\": \"0FB...\",\n    \"lastFeedAccessDate\": null,\n    \"role\": \"StandardMember\",\n    \"url\": \"/services/data/v58.0/chatter/group-memberships/0FB...\",\n    \"user\": {\n        \"additionalLabel\": null,\n        \"communityNickname\": \"integration1.4407085834085586E12\",\n        \"companyName\": \"Salesforce\",\n        \"displayName\": \"Integration User\",\n        \"firstName\": \"Integration\",\n        \"id\": \"005...\",\n        \"isActive\": true,\n        \"isInThisCommunity\": true,\n        \"lastName\": \"User\",\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\": \"Integration User\",\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}"
    }
  ]
}