Chilkat Online Tools

delphiDll / Salesforce Platform APIs / Group Members

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
lastFeedAccessDate: PWideChar;
role: PWideChar;
url: PWideChar;
AdditionalLabel: PWideChar;
CommunityNickname: PWideChar;
CompanyName: PWideChar;
DisplayName: PWideChar;
FirstName: PWideChar;
Id: PWideChar;
IsActive: Boolean;
IsInThisCommunity: Boolean;
LastName: PWideChar;
Color: PWideChar;
LargeIconUrl: PWideChar;
MediumIconUrl: PWideChar;
SmallIconUrl: PWideChar;
SvgIconUrl: PWideChar;
MySubscription: PWideChar;
Name: PWideChar;
Message: PWideChar;
FullEmailPhotoUrl: PWideChar;
LargePhotoUrl: PWideChar;
MediumPhotoUrl: PWideChar;
PhotoVersionId: PWideChar;
SmallPhotoUrl: PWideChar;
StandardEmailPhotoUrl: PWideChar;
v_Url: PWideChar;
Reputation: PWideChar;
Title: PWideChar;
v_Type: PWideChar;
userUrl: PWideChar;
UserType: PWideChar;

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

http := CkHttp_Create();

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

resp := CkHttp_QuickRequest(http,'POST','https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

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

id := CkJsonObject__stringOf(jResp,'id');
lastFeedAccessDate := CkJsonObject__stringOf(jResp,'lastFeedAccessDate');
role := CkJsonObject__stringOf(jResp,'role');
url := CkJsonObject__stringOf(jResp,'url');
AdditionalLabel := CkJsonObject__stringOf(jResp,'user.additionalLabel');
CommunityNickname := CkJsonObject__stringOf(jResp,'user.communityNickname');
CompanyName := CkJsonObject__stringOf(jResp,'user.companyName');
DisplayName := CkJsonObject__stringOf(jResp,'user.displayName');
FirstName := CkJsonObject__stringOf(jResp,'user.firstName');
Id := CkJsonObject__stringOf(jResp,'user.id');
IsActive := CkJsonObject_BoolOf(jResp,'user.isActive');
IsInThisCommunity := CkJsonObject_BoolOf(jResp,'user.isInThisCommunity');
LastName := CkJsonObject__stringOf(jResp,'user.lastName');
Color := CkJsonObject__stringOf(jResp,'user.motif.color');
LargeIconUrl := CkJsonObject__stringOf(jResp,'user.motif.largeIconUrl');
MediumIconUrl := CkJsonObject__stringOf(jResp,'user.motif.mediumIconUrl');
SmallIconUrl := CkJsonObject__stringOf(jResp,'user.motif.smallIconUrl');
SvgIconUrl := CkJsonObject__stringOf(jResp,'user.motif.svgIconUrl');
MySubscription := CkJsonObject__stringOf(jResp,'user.mySubscription');
Name := CkJsonObject__stringOf(jResp,'user.name');
Message := CkJsonObject__stringOf(jResp,'user.outOfOffice.message');
FullEmailPhotoUrl := CkJsonObject__stringOf(jResp,'user.photo.fullEmailPhotoUrl');
LargePhotoUrl := CkJsonObject__stringOf(jResp,'user.photo.largePhotoUrl');
MediumPhotoUrl := CkJsonObject__stringOf(jResp,'user.photo.mediumPhotoUrl');
PhotoVersionId := CkJsonObject__stringOf(jResp,'user.photo.photoVersionId');
SmallPhotoUrl := CkJsonObject__stringOf(jResp,'user.photo.smallPhotoUrl');
StandardEmailPhotoUrl := CkJsonObject__stringOf(jResp,'user.photo.standardEmailPhotoUrl');
v_Url := CkJsonObject__stringOf(jResp,'user.photo.url');
Reputation := CkJsonObject__stringOf(jResp,'user.reputation');
Title := CkJsonObject__stringOf(jResp,'user.title');
v_Type := CkJsonObject__stringOf(jResp,'user.type');
userUrl := CkJsonObject__stringOf(jResp,'user.url');
UserType := CkJsonObject__stringOf(jResp,'user.userType');

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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