Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
createdDate.s
id.s
lastUpdateDate.s
Id.s
v_Url.s
responseMessage.s
status.s
url.s
AdditionalLabel.s
CommunityNickname.s
CompanyName.s
DisplayName.s
FirstName.s
userId.s
IsActive.i
IsInThisCommunity.i
LastName.s
Color.s
LargeIconUrl.s
MediumIconUrl.s
SmallIconUrl.s
SvgIconUrl.s
MySubscription.s
Name.s
Message.s
FullEmailPhotoUrl.s
LargePhotoUrl.s
MediumPhotoUrl.s
PhotoVersionId.s
SmallPhotoUrl.s
StandardEmailPhotoUrl.s
PhotoUrl.s
Reputation.s
Title.s
v_Type.s
userUrl.s
UserType.s
total.s = CkJsonObject::ckStringOf(jResp,"total")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"requests")
While i < count_i
CkJsonObject::setCkI(jResp, i)
createdDate = CkJsonObject::ckStringOf(jResp,"requests[i].createdDate")
id = CkJsonObject::ckStringOf(jResp,"requests[i].id")
lastUpdateDate = CkJsonObject::ckStringOf(jResp,"requests[i].lastUpdateDate")
Id = CkJsonObject::ckStringOf(jResp,"requests[i].requestedGroup.id")
v_Url = CkJsonObject::ckStringOf(jResp,"requests[i].requestedGroup.url")
responseMessage = CkJsonObject::ckStringOf(jResp,"requests[i].responseMessage")
status = CkJsonObject::ckStringOf(jResp,"requests[i].status")
url = CkJsonObject::ckStringOf(jResp,"requests[i].url")
AdditionalLabel = CkJsonObject::ckStringOf(jResp,"requests[i].user.additionalLabel")
CommunityNickname = CkJsonObject::ckStringOf(jResp,"requests[i].user.communityNickname")
CompanyName = CkJsonObject::ckStringOf(jResp,"requests[i].user.companyName")
DisplayName = CkJsonObject::ckStringOf(jResp,"requests[i].user.displayName")
FirstName = CkJsonObject::ckStringOf(jResp,"requests[i].user.firstName")
userId = CkJsonObject::ckStringOf(jResp,"requests[i].user.id")
IsActive = CkJsonObject::ckBoolOf(jResp,"requests[i].user.isActive")
IsInThisCommunity = CkJsonObject::ckBoolOf(jResp,"requests[i].user.isInThisCommunity")
LastName = CkJsonObject::ckStringOf(jResp,"requests[i].user.lastName")
Color = CkJsonObject::ckStringOf(jResp,"requests[i].user.motif.color")
LargeIconUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.motif.largeIconUrl")
MediumIconUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.motif.mediumIconUrl")
SmallIconUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.motif.smallIconUrl")
SvgIconUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.motif.svgIconUrl")
MySubscription = CkJsonObject::ckStringOf(jResp,"requests[i].user.mySubscription")
Name = CkJsonObject::ckStringOf(jResp,"requests[i].user.name")
Message = CkJsonObject::ckStringOf(jResp,"requests[i].user.outOfOffice.message")
FullEmailPhotoUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.photo.fullEmailPhotoUrl")
LargePhotoUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.photo.largePhotoUrl")
MediumPhotoUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.photo.mediumPhotoUrl")
PhotoVersionId = CkJsonObject::ckStringOf(jResp,"requests[i].user.photo.photoVersionId")
SmallPhotoUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.photo.smallPhotoUrl")
StandardEmailPhotoUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.photo.standardEmailPhotoUrl")
PhotoUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.photo.url")
Reputation = CkJsonObject::ckStringOf(jResp,"requests[i].user.reputation")
Title = CkJsonObject::ckStringOf(jResp,"requests[i].user.title")
v_Type = CkJsonObject::ckStringOf(jResp,"requests[i].user.type")
userUrl = CkJsonObject::ckStringOf(jResp,"requests[i].user.url")
UserType = CkJsonObject::ckStringOf(jResp,"requests[i].user.userType")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
