Chilkat Online Tools

DataFlex / Salesforce Platform APIs / Group Members

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sLastFeedAccessDate
    String sRole
    String sUrl
    String sAdditionalLabel
    String sCommunityNickname
    String sCompanyName
    String sDisplayName
    String sFirstName
    String sId
    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 sV_Url
    String sReputation
    String sTitle
    String sV_Type
    String sUserUrl
    String sUserType
    String sTemp1
    Boolean bTemp1

    // 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 ComQuickRequest Of hoHttp "POST" "https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>" To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    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 ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

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

    Get ComStringOf Of hoJResp "id" To sId
    Get ComStringOf Of hoJResp "lastFeedAccessDate" To sLastFeedAccessDate
    Get ComStringOf Of hoJResp "role" To sRole
    Get ComStringOf Of hoJResp "url" To sUrl
    Get ComStringOf Of hoJResp "user.additionalLabel" To sAdditionalLabel
    Get ComStringOf Of hoJResp "user.communityNickname" To sCommunityNickname
    Get ComStringOf Of hoJResp "user.companyName" To sCompanyName
    Get ComStringOf Of hoJResp "user.displayName" To sDisplayName
    Get ComStringOf Of hoJResp "user.firstName" To sFirstName
    Get ComStringOf Of hoJResp "user.id" To sId
    Get ComBoolOf Of hoJResp "user.isActive" To iIsActive
    Get ComBoolOf Of hoJResp "user.isInThisCommunity" To iIsInThisCommunity
    Get ComStringOf Of hoJResp "user.lastName" To sLastName
    Get ComStringOf Of hoJResp "user.motif.color" To sColor
    Get ComStringOf Of hoJResp "user.motif.largeIconUrl" To sLargeIconUrl
    Get ComStringOf Of hoJResp "user.motif.mediumIconUrl" To sMediumIconUrl
    Get ComStringOf Of hoJResp "user.motif.smallIconUrl" To sSmallIconUrl
    Get ComStringOf Of hoJResp "user.motif.svgIconUrl" To sSvgIconUrl
    Get ComStringOf Of hoJResp "user.mySubscription" To sMySubscription
    Get ComStringOf Of hoJResp "user.name" To sName
    Get ComStringOf Of hoJResp "user.outOfOffice.message" To sMessage
    Get ComStringOf Of hoJResp "user.photo.fullEmailPhotoUrl" To sFullEmailPhotoUrl
    Get ComStringOf Of hoJResp "user.photo.largePhotoUrl" To sLargePhotoUrl
    Get ComStringOf Of hoJResp "user.photo.mediumPhotoUrl" To sMediumPhotoUrl
    Get ComStringOf Of hoJResp "user.photo.photoVersionId" To sPhotoVersionId
    Get ComStringOf Of hoJResp "user.photo.smallPhotoUrl" To sSmallPhotoUrl
    Get ComStringOf Of hoJResp "user.photo.standardEmailPhotoUrl" To sStandardEmailPhotoUrl
    Get ComStringOf Of hoJResp "user.photo.url" To sV_Url
    Get ComStringOf Of hoJResp "user.reputation" To sReputation
    Get ComStringOf Of hoJResp "user.title" To sTitle
    Get ComStringOf Of hoJResp "user.type" To sV_Type
    Get ComStringOf Of hoJResp "user.url" To sUserUrl
    Get ComStringOf Of hoJResp "user.userType" To sUserType


End_Procedure

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